WoW:Sky (AddOn): Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (replaced SKY_CHANNEL_LEFT in the skyHostess.action description with SKY_CHANNEL_LEAVE)
Line 1: Line 1:
  --[[
  --[[
  -- sendMessage(message [, system, target, player])
  -- registerHostess( {skyHostess} [, {skyHostess}] )
--
  -- Registers a hostess who gets informed as channels are made available,
  -- Sends a simple text message to a  
  -- removed, or when players are joined/added.  
  -- specified target using Sky.
--
-- Args:
-- message - the text to be delivered
--
-- optional (Default is an unencoded "SAY" to no particular target):
--
-- system - channel/system used for transport
-- SKY_CHANNEL |"global" - sends to all Sky users
-- SKY_PARTY  - sends to party members using Sky
-- SKY_GUILD - sends to all guild members using Sky
-- SKY_RAID - sends to all raid members using Sky
-- SKY_PLAYER - sends to a player using Sky, through a hidden whisper
-- "SAY" sends to the world regardless of Sky usage
-- "WHISPER" sends to a player regardless of Sky usage
-- "PARTY" sends to a party regardless of Sky usage
-- "GUILD" sends to a guild regardless of Sky usage
-- "RAID" sends to a raid regardless of Sky usage
-- "CHANNEL" sends to a particular channel (1, general, etc)
--
-- target - destination mailbox
-- This value will be the .target value of the envelope sent to acceptTest
--
-- player -
-- ( channel identifier for "CHANNEL" )
-- ( playername for SKY_PLAYER/"WHISPER" )
-- ( nil for everything else )
  --
  --
-- 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_LEAVE
-- 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
-- }
  --]]
  --]]
Note: If using "say" "party", etc, be very careful about it. Non Sky users will see the spam.

Revision as of 23:35, 15 August 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_LEAVE
--					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
--			}
--]]
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:Sky_(AddOn)&oldid=5445"