Difference between revisions of "Cabal Common Library Doc Music"
m |
m |
||
| Line 27: | Line 27: | ||
{{CodeEx|codeex=addMedia = function( obj )}} | {{CodeEx|codeex=addMedia = function( obj )}} | ||
Adds incoming object to the list and associates the entries to the sending worldScript. | Adds incoming object to the list and associates the entries to the sending worldScript. | ||
| − | Internally every entry gets | + | Internally every entry gets a group ID, so don't pass non-writable, sealed or frozen objects. |
'''Properties:''' | '''Properties:''' | ||
:;who:String. Required. Name of the sending worldScript. | :;who:String. Required. Name of the sending worldScript. | ||
| − | :;start:Boolean. Required. Starting state after insertion. | + | :;start:Boolean. Required. Starting state for the group after insertion. |
:;aegis:Object. Allowed members: enter<sup>3</sup>, exit<sup>3</sup>. | :;aegis:Object. Allowed members: enter<sup>3</sup>, exit<sup>3</sup>. | ||
:;alert:Object. Allowed members: red, yellow<sup>1</sup>, green<sup>1</sup>. | :;alert:Object. Allowed members: red, yellow<sup>1</sup>, green<sup>1</sup>. | ||
| Line 55: | Line 55: | ||
=== removeMedia() === | === removeMedia() === | ||
{{CodeEx|codeex=removeMedia = function( who )}} | {{CodeEx|codeex=removeMedia = function( who )}} | ||
| − | Removes entries from the stored list. | + | Removes all entries of a group from the stored list. |
'''Properties:''' | '''Properties:''' | ||
| Line 66: | Line 66: | ||
=== changeStatus() === | === changeStatus() === | ||
{{CodeEx|codeex=changeStatus = function( who, status )}} | {{CodeEx|codeex=changeStatus = function( who, status )}} | ||
| − | + | Changes the group state for a specific group. | |
'''Properties:''' | '''Properties:''' | ||
:;who:String. Name of the worldScript. | :;who:String. Name of the worldScript. | ||
| − | :;status:Boolean. | + | :;status:Boolean. Sets the group flag for all inserted files of a specific worldScript group. |
'''Returns''' | '''Returns''' | ||
Revision as of 18:31, 9 August 2011
Contents
Overview
This is the main class for the event driven inflight music for missions.
The script handles incoming data from worldScripts to play music in specific situations. OXPs can place or remove their sets fairly simple and a few parameters are handled. The inserted data is associated to the inserting worldScript by ID and the whole group of events can be easily de/activated at every time via .changeStatus(). Additionally a property can be assigned to a specific event, means that different entries can be de/activated by using different properties.
Note: Length, volume and fadeIn/fadeOut in the audio itself are important factors for a smooth transition between 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
requestHandlerSet
On startUp created set of handlers (Array) for Cabal_Common_Music.
| var a = worldScripts.Cabal_Common_Music.requestHandlerSet;
a -> [ [aegis, enter, exit], [alert, red, ... ] ... ] |
Functions
addMedia()
| addMedia = function( obj ) |
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.
Properties:
- who
- String. Required. Name of the sending worldScript.
- start
- Boolean. Required. Starting state for the group after insertion.
- aegis
- Object. Allowed members: enter3, exit3.
- alert
- Object. Allowed members: red, yellow1, green1.
- 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: ent3, enterMain3, enterSun3, exitMain3, exitSun3.
- scooped
- Object. Allowed members: ent2.
- track
- Object. Allowed members: byName.
Returns
- Boolean
- True on success, false on failure.
1 If other handlers have fired blocked for 10 seconds.
2 The handler is only fired for scripted pods.
3 Can collide, because aegis and planet vicinities can be close together.
The above mentioned members are all of type Array and are holding the music related objects.
See Structure for a overview.
removeMedia()
| removeMedia = function( who ) |
Removes all entries of a group from the stored list.
Properties:
- who
- String. Name of the worldScript.
Returns
- Boolean
- True on success, false on failure.
changeStatus()
| changeStatus = function( who, status ) |
Changes the group state for a specific group.
Properties:
- who
- String. Name of the worldScript.
- status
- Boolean. Sets the group flag for all inserted files of a specific worldScript group.
Returns
- Boolean
- True on success, false on failure.
Structure
A short overview about the expected structure:
var eventMusic = {
}; |
The objects that are holding the music itself have a set of available properties as well, but only music is required.
- dist
- Number. Min. distance to entity. Only available in track.
- ent
- String. Entity name. Available in destroyed, launch, planet, scooped and track.
- fadeQ
- Number. Sound as transition between musicfiles. If used must be 1 (will be expanded).
- music
- String. Filename with fileextension.
- prop
- String. Name of worldScript property to be checked.
