Lib Music - Revision history

Svengali: Example overhaul

2018-10-06T17:23:48Z

Example overhaul

Svengali: Added volume parameter

2016-10-28T14:05:17Z

Added volume parameter

Svengali: Part III

2016-08-15T09:13:51Z

Part III

Svengali: Part II

2016-08-14T18:23:03Z

Part II

Svengali: Documentation

2016-08-14T17:01:18Z

Documentation

New page

[[Image:IconLib.png|100px|right]]
==Overview==
Lib_Music (part of [[Library]]) is an expandable event driven music player, but also the successor to [[Hyperradio]].

==Events==
Events are handled through Oolites handler (e.g. shipExitedWitchspace). Lib_Music uses handlers which are not fired repeatedly and selects one of the music entries randomly for the specified event. Event music is particulary interesting for mission related things.

=== _addEventMusic===
{{CodeEx|codeex= _addEventMusic: function( obj, ID )}}
Clones the passed Object and adds entries silently to the event Arrays. Without activating the GroupID via [[#_toggleGroup|_toggleGroup]] none of them will be played. The passed Object can use any of the members of [[#$media|$media]], except radio (which is reserved for queued music)!

'''Parameters:'''
:;obj:Object. See [[#$media|$media]] for its members. The entries must contain snd: <filename> and dur: duration seconds <integer>.

'''Returns:'''
:;true or false.

Example:
worldScripts.Lib_Music._addEventMusic({
aegis:{
enter:[ {snd:"MyOXP_AegisFile.ogg",dur:98} ]
}
},"MyGroupID");

===_toggleGroup===
{{CodeEx|codeex= _toggleGroup: function( ID )}}
Toggles the status for GroupID if it exists. If priority mode is active the change is inactive until priority mode is cleared.

'''Parameters:'''
:;ID:String.

'''Returns:'''
:;n:Number. 0 or 1. The current status.

===_setPriorityGroup===
Take priority for specified GroupID. Resets and stores the current status, disables all other GroupIDs and enables this GroupID. This method is particulary interesting for mission related things.

===_clrPriorityGroup===
Clear priority mode. Resets the status of all GroupIDs.

====$media====
$media = {
aegis:{enter:[], exit:[]},
alert:{red:[]},
docked:{main:[], any:[]},
exitWS:{inter:[], goneNova:[], doNova:[], standard:[]},
killed:{any:[]},
launch:{inter:[], goneNova:[], doNova:[], main:[], any:[]},
planetIn:{enterMain:[], enterSun:[], any:[]},
planetOut:{exitMain:[], exitSun:[], any:[]},
radio:{generic:[]},
rescued:{any:[]},
scooped:{any:[]},
scoopFuel:{fuel:[]}
};

==Channels==
Channels are used as playlists. As long as no other event gets triggered and the status doesn't change Lib_Music will continue to pick another one from the currently active radio channel. If a channel is explicitely set via _setChannel() it will use this channel until it gets unset (both docked and inflight). Otherwise - If docked it will use either a channel that is equal to the name of the station or the "generic" channel. Inflight it uses either the "docking" channel for the autopilot, "fight" for dangerous situations or "generic".

===_addChannel===

===_setChannel===

[[Category:OXPDoc]]

@@ Line 32: / Line 32: @@
 '''Parameters:'''
-:;obj:Object. See [[#$media|$media]] for its members. The entries must contain snd: <filename> and dur: duration seconds <integer>.
+:;obj:Object. See [[#$media|$media]] for its members. The entries must contain
 '''Returns:'''
@@ Line 118: / Line 118: @@
 :;obj:Object with members:
 ::;name:String.
-::;sounds:Array. The entries must contain snd: <filename> and dur: duration seconds <integer>.
+::;sounds:Array. The entries must contain
 ::;radio:Boolean. Optional.

@@ Line 6: / Line 6: @@
 ==Events==
 Events are handled through Oolites handler (e.g. shipExitedWitchspace). Lib_Music uses handlers which are not fired repeatedly and selects one of the music entries randomly for the specified event. Event music is particulary interesting for mission related things.
 Any of the following methods should be used on [[Oolite_JavaScript_Reference:_World_script_event_handlers#startUpComplete|.startUpComplete]] or later.
@@ Line 112: / Line 129: @@
 ===_setChannel===
 Sets or clears custom radio channel.

@@ Line 36: / Line 36: @@
 :::;dur: duration seconds <integer>
 :::;vol: volume 0...1 <float> (Optional) {{AV|1.1}}
 '''Returns:'''
@@ Line 43: / Line 44: @@
   worldScripts.Lib_Music._addEventMusic({
     aegis:{
-      enter:[ {snd:"MyOXP_AegisFile.ogg",dur:98} ]
+      enter:[
+    }
   },"MyGroupID");
@@ Line 53: / Line 54: @@
 '''Parameters:'''
-:;ID:String.
+:;ID:String. Group name.
 '''Returns:'''

@@ Line 1: / Line 1: @@
 [[Image:IconLib.png|100px|right]]
 ==Overview==
-Lib_Music (part of [[Library]]) is an expandable event driven music player, but also the successor to [[Hyperradio]].
+Lib_Music (part of [[Library]]) is an expandable event driven music player, but also the successor to [[Hyperradio]]. If 'Radio'-AddOns are used the radio-channels are configurable through [[Lib_Config]].
 ==Events==
 Events are handled through Oolites handler (e.g. shipExitedWitchspace). Lib_Music uses handlers which are not fired repeatedly and selects one of the music entries randomly for the specified event. Event music is particulary interesting for mission related things.
@@ Line 35: / Line 37: @@
 '''Returns:'''
 :;n:Number. 0 or 1. The current status.
 ===_setPriorityGroup===
 ===_clrPriorityGroup===
 Clear priority mode. Resets the status of all GroupIDs.
 ====$media====
     aegis:{enter:[], exit:[]},
     alert:{red:[]},
@@ Line 63: / Line 89: @@
 ==Channels==
-Channels are used as playlists. As long as no other event gets triggered and the status doesn't change Lib_Music will continue to pick another one from the currently active radio channel. If a channel is explicitely set via _setChannel() it will use this channel until it gets unset (both docked and inflight). Otherwise - If docked it will use either a channel that is equal to the name of the station or the "generic" channel. Inflight it uses either the "docking" channel for the autopilot, "fight" for dangerous situations or "generic".
+Channels are used as playlists. As long as no other event gets triggered and the status doesn't change Lib_Music will continue to pick another one from the currently active radio channel. If a channel is explicitely set via _setChannel() it will use this channel until it gets unset (both docked and inflight). Otherwise - if docked it will use either a channel that is equal to the name of the station or the "generic" channel. Inflight it uses either the "docking" channel for the autopilot, "fight" for dangerous situations or "generic".
 ===_addChannel===
 ===_setChannel===