Cabal Common Library Doc Music

From Elite Wiki
Revision as of 18:55, 8 August 2011 by Svengali (talk | contribs) (Started Doc for CCL_Music)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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.


Properties

requestHandlerSet

On startUp created set of handlers for Cabal_Common_Music.

TODO - Example.


Functions

addMedia()

addMedia = function( obj )

Adds incoming object to the list and associates the entries to the sending worldScript.

Properties:

who
String. Required. Name of the sending worldScript.
start
Boolean. Required. Starting state after insertion.
aegis
Object. Allowed members: TODO
alert
Object. Allowed members: TODO
destroyed
Object. Allowed members: TODO
exitWS
Object. Allowed members: TODO
launch
Object. Allowed members: TODO
planet
Object. Allowed members: TODO
scooped
Object. Allowed members: TODO
track
Object. Allowed members: TODO

Returns

Boolean
True on success, false on failure.


TODO - Infos about members.


removeMedia()

removeMedia = function( who )

Removes entries from the stored list.

Properties:

who
String. Name of the worldScript.

Returns

Boolean
True on success, false on failure.


changeStatus()

changeStatus = function( who, status )

Removes entries from the stored list.

Properties:

who
String. Name of the worldScript.
status
Boolean. Changes the active flag for all inserted files of a specific worldScript.

Returns

Boolean
True on success, false on failure.