WoW:Sky (AddOn): Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
({{funclib|Sky}})
(Sky 1.10)
Line 1: Line 1:
{{funclib|Sky}}
{{funclib|Sky}}
   
  --[[
  --[[ Validates a Hostess ]]--
  -- 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 Encoded & Hidden Messages)
-- SKY_CHANNEL |"global" - sends to all Sky users
-- SKY_GROUP  - sends to party/raid members using Sky
-- SKY_GUILD - sends to all guild members using Sky
-- SKY_PLAYER - sends to a player using Sky, through a hidden whisper
-- (Pure/Visible Messages)
-- "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 )
--
--]]


{{Stub/Other}}
*This can be used for regular chat, the only difference from SendChatMessage will be that it will be bound by the outbound character limit and chopped into pieces if it's too long.
*SAY, WHISPER, PARTY, GUILD, RAID and CHANNEL messages will not be parsed or have special characters encoded.
*SKY_CHANNEL, SKY_GROUP, SKY_GUILD, and SKY_PLAYER have line breaks, "s", "S" and "|" converted to invisible characters and back to their correct characters on the recieving end.
 
EX:
Sky.sendMessage("Group Members Rock!", "PARTY")
Sky.sendMessage("Whispers Rock!", "WHISPER", nil, "PlayerName")
Sky.sendMessage("101101001 Blah", SKY_CHANNEL, "AddonID")

Revision as of 23:34, 7 July 2006

This article is a part of the documentation of the Sky (AddOn) function library
--[[
--	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 Encoded & Hidden Messages)
--			SKY_CHANNEL |"global" - sends to all Sky users
--			SKY_GROUP  - sends to party/raid members using Sky
--			SKY_GUILD - sends to all guild members using Sky
--			SKY_PLAYER - sends to a player using Sky, through a hidden whisper
--			(Pure/Visible Messages)
--			"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 )
--
--]]
  • This can be used for regular chat, the only difference from SendChatMessage will be that it will be bound by the outbound character limit and chopped into pieces if it's too long.
  • SAY, WHISPER, PARTY, GUILD, RAID and CHANNEL messages will not be parsed or have special characters encoded.
  • SKY_CHANNEL, SKY_GROUP, SKY_GUILD, and SKY_PLAYER have line breaks, "s", "S" and "|" converted to invisible characters and back to their correct characters on the recieving end.

EX:

Sky.sendMessage("Group Members Rock!", "PARTY")
Sky.sendMessage("Whispers Rock!", "WHISPER", nil, "PlayerName")
Sky.sendMessage("101101001 Blah", SKY_CHANNEL, "AddonID")