SkyHostess

From WoWWiki

This article is a part of the documentation of the Sky function library

--skyHostess - table
--	{
--		id - unique id for the hostess
--		callback - function called when a channel event occurs
--			(action, actionData)
--			action - string containing 
--			SKY_PLAYER_JOIN|SKY_PLAYER_LEAVE|SKY_CHANNEL_LIST|SKY_CHANNEL_JOIN|SKY_CHANNEL_LEFT
--			actionData - table
--				{
--					channel - channel name (SKY_CHANNEL or whatever)
--					
--				(action dependent:)
--					username - string - username of the player who joined/left
--					list - table - users in channel
--				}
--			
--		channels - table containing SkyIdentifiers and/or Server Channel IDs
--			SKY_CHANNEL, SKY_PARTY, "general", etc
--	}

A Sky Hostess is a type of notifier who will inform you when users join/leave or when channels are started/ended.

Contents 1 Table Elements 1.1 id 1.2 callback 1.3 channels 2 Q) Why Hostess?

Table Elements

id

• Unique String ID for the hostess String ID

callback

• Function that will be called when the specified event occurs

  Args

  action - string containing one of the following:

  SKY_PLAYER_JOIN|SKY_PLAYER_LEAVE|SKY_CHANNEL_LIST|SKY_CHANNEL_JOIN|SKY_CHANNEL_LEFT

  actionData - table

  table elements:

  channel - SkyIdentifier or Server Channel ID

  username - (String, only on JOINs/LEAVEs) username of the player who joined/left

  list - (Table, only on LIST) users in channel

channels

• A table of channels which will be watched to incurr callbacks on related events.
  • Can be SkyIdentifiers and/or Server Channel IDs

Q) Why Hostess?

A) Think of a hostess who needs to know when people arrive or leave her party. She wants to greet them when they come inside, or wish them farewell when they leave. She also knows when the party begins and ends. Fits, right?