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:
  --[[
  --[[
  -- checkBandwidth()
  -- sendMessage(message [, system, target, player])
  -- Check the status of the bandwidth limit.
--
  -- returns:
-- Sends a simple text message to a
  -- A positive or negative number, the size of which indicates how
  -- specified target using Sky.  
  -- much over (positive) or under (negative) the client is relative
  --
  -- to the bandwidth limit.
-- 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 )
--
  --]]
  --]]
Note: If using "say" "party", etc, be very careful about it. Non Sky users will see the spam.

Revision as of 17:17, 14 August 2005

--[[
--	sendMessage(message [, system, target, player])
--
--		Sends a simple text message to a 
--		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 )
--
--]]

Note: If using "say" "party", etc, be very careful about it. Non Sky users will see the spam.