WoW:Sky (AddOn): Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
  --[[
  --[[
-- registerHostess( {skyHostess} [, {skyHostess}] )
-- Registers a hostess who gets informed as channels are made available,
-- removed, or when players are joined/added.
  --
  --
  -- registerMailbox({mailboxRegistrant}, ...)
  -- args:
  --
-- skyHostess - table
  -- Registers a mailbox which will drop messages into a
-- {
  -- mailbox matching id, if acceptTest(message) returns true.
-- id - unique id for the hostess
  --
-- callback - function called when a channel even occurs
  -- See the mailboxRegistrant definition for more details
-- (action, actionData)
  --
  -- action - string containing
  -- Returns:
-- SKY_PLAYER_JOIN|SKY_PLAYER_LEAVE|SKY_CHANNEL_LIST|SKY_CHANNEL_JOIN|SKY_CHANNEL_LEFT
  -- true if successful
  -- actionData - table
  -- false if unable to register
-- {
  -- 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 channels
  -- SKY_CHANNEL, SKY_PARTY, "general", etc
  -- description - short string describing the addon
  -- }
  --]]
  --]]

Revision as of 17:21, 23 February 2005

--[[
--	registerHostess( {skyHostess} [, {skyHostess}] )
--		Registers a hostess who gets informed as channels are made available,
--		removed, or when players are joined/added. 
--
--	args:
--		skyHostess - table
--			{
--				id - unique id for the hostess
--				callback - function called when a channel even 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 channels
--					SKY_CHANNEL, SKY_PARTY, "general", etc
--				description - short string describing the addon
--			}
--]]