Sky

From WoWDev

This is an article about WoW Interface Customization : AddOns/Function Libraries.

"Dark wings, dark words" - Jon

Sky is a communications library designed to make adding /commands and sharing data silently between clients using chat channels much easier.

NOTE (21 Jun 2005): There are currently two versions of Sky: 'Sky' and 'SkyLight'. The recommended and fully supported version is the 'SkyLight' version, a largely rewritten version of Sky by AnduinLothar (aka KarlKFI). SkyLight is available from Curse-Gaming.com. The old Sky version is still in Cosmos for the time being. SkyLight fully replaces Sky and uses the same coding standards with more advances and optimized implimentation. SkyLight no longer handles channel index masking nor many of the 'enhancements' that were so buggy in the original versions. The one code difference to note is that SkyChannelManager.getLiveChannelCount has been replaced by SkyChannelManager.getChannelCount in SkyLight.

Sky and SkyLight Dependancies: Sea and Chronos

[edit]

Sky Documentation

Sky provides hidden channels--Sky, SkyParty, SkyRaid, SkyZone, and SkyGuild--which can be automatically updated. The Sky Channels provide additional communication options; for example, you can send a message to a single person or to your entire guild which can be read later, or you can rush an 'alert' to a person or guild....

For a full summary and introduction to Sky, see [1].

Template:Notify KarlKFI

Basic Example of a Sky command:

Sky.sendMessage("Group Members Rock!", "party");
/ Sends the message "Group Members Rock" to the party (group) channel.

[edit]

Sky Functions

Utilties
- activate - Turns Sky online
- deactivate - Turns Sky offline
- isChannelActive - Checks if a channel is available
- isSkyUser - Checks if a user has been seen using Sky
- checkBandwidth - Check status of bandwidth limitations
Message Delivery
- sendMessage - Send a text message
- sendAlert - Sends a high priority message
- sendTable - Send a table of data
- sendPure - Sends a clear-text message
Message Recieving
- registerMailbox - Registers a mailbox
- unregisterMailbox - Unregister mailbox
- validateMailbox - Ensures a mailbox is correct
- updateMailbox - Updates the values of a mailbox
- getNextMessage - Retrieves a message from the mailbox queue
- getAllMessages - Retrieves all of the messages for a specific mailbox queue
- emptyMailbox - Empties the mailbox for a specific mailbox ID
Alert Registrations
- registerAlert - Registers an alert handler
- unregisterAlert - Unregisters an alert handler
- validateAlert - Ensures an alert registrant is correct
- updateAlert - Updates the values of an alert
User Channel Update Registration
- registerHostess - Registers a hostess
- validateHostess - Ensures a hostess is ok
- updateHostess - Updates the values of a hostess
- unregisterHostess - Unregisters a hostess
- isHostingByID - Checks if hostess exists for the ID
Slash Commands
- registerSlashCommand - Registers a /command
- unregisterSlashCommand - Unregisters a /command set
- validateSlashCommand - Ensures a /command is valid
- updateSlashCommand - Updates the values of a /command