WoW:Telepathy: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (→‎Summary: spelling)
m (Move page script moved page Telepathy to Telepathy without leaving a redirect)
 
(7 intermediate revisions by 6 users not shown)
Line 1: Line 1:
==Summary==
#REDIRECT [[Telepathy (AddOn)]]
*Network Chat Communication Library for Mods
 
*Telepathy is a chat communications library for cross client addon information sharing. It uses SendAddonMessage for "PARTY", "RAID", "GUILD" or "BATTLEGROUND" communication and hidden chat messages for "GLOBAL" or "WHISPER" communication. Global comm uses a global (faction/server wide) channel called "GlobalComm" while whispers are prefixed with "<nowiki><T></nowiki>" and hidden on the sending and receiving ends.
 
*Telepathy maintains a user list of everyone in the "GlobalComm" channel, but because other addons also use this standard comm channel it does not mean they are necessarily using Telepathy. Telepathy will automatically join "GlobalComm" after the other channels have loaded if an addon has registered a listener for "GLOBAL". The player can also opt to disable auto-join/leave using "/gcautojoin 0" or "/gcautojoin 1" to enable it again.
 
*Embedded Libs (Standalone vers): [[ChatThrottleLib]], [[SeaHooks]], [[SeaPrint]], [[SeaString]], [[Chronos]] and [[Satellite]]
 
<!-- *Included in the [[Cosmos]] distribution. -->
 
==Download==
*The most current version is available at [http://www.cosmosui.org/addons.php www.cosmosui.org].
*Stand alone available at [http://www.wowinterface.com/downloads/fileinfo.php?s=&id=5219 www.wowinterface.com].
*[[Telepathy/ChangeLog|Change Log]]
 
==Features==
*Embeddable library
*Works for raids, parties, guilds and battlegrouds
*Standard/shared global channel name (only ever uses 1 and it is only joined when used)
*Addons merely needs to register a listener and send messages with the Telepathy API for minimal usage
*Performs basic flood control through ChatThrottleLib
*Message priority system for alerts, bulk data and normal messages.
*Datagrams are automaticly fragmented, queued and reconstructed for multiple message transfers
*Telepathy.sendTable allows for serialization and direct transfer of lua tables for everything but functions
*Telepathy global and whisper messages are automaticly forcibly suppressed via a ChatFrame_OnEvent hook and the other messages are not read by the default ChatFrames. This can also be circumvented for debugging.
*Verbose debug options for seeing hidden chat and diagnosing problems using Sea.io.error (prints to chatframe or optionally ImprovedErrorFrame)
 
==Built-in Slash Commands==
*/gcautojoin 1/0  - Allow (1) or Dissallow (0) auto-joining of a GlobalComm Channel when needed
 
==Quick Start Example==
 
===Minimal Required Example===
Basic Example of a Telepathy command:
 
Telepathy.registerListener("TelepathyTest", "WHISPER",
function(msg, sender) Sea.io.printComma("TelepathyTester1: ", msg, sender) end
);
Telepathy.sendMessage("TelepathyTest", "This whisper is invisible!", "WHISPER", UnitName('player'));
 
==User Functions==
* Outbound Messages
** [[Telepathy.sendMessage|sendMessage]] - Sends a hidden text message to a specified target or channel.
** [[Telepathy.sendTable|sendTable]] - Sends a lua serialized object using Telepathy.
* Listener Registration
** [[Telepathy.registerListener|registerListener]] - Registers a listener which will call a callback function when a message is recieved.
** [[Telepathy.unregisterListener|unregisterListener]] - Unregisters a listener.
** [[Telepathy.isListener|isListener]] - Checks if the id/method is already in use.
* Global Channel Management
** [[Telepathy.isInGlobalChannel|isInGlobalChannel]] - Checks if a user (by name) is in the GlobalComm channel
** [[Telepathy.getCurrentChannelTable|getCurrentChannelTable]] - Gets an iteratable list of active channels.
** [[Telepathy.getChannelCount|getChannelCount]] - Returns the number of channels you are currently in.
 
==Embedding==
To embed Telepathy in your addon:
:1) Drop the Telepathy folder in your addon folder
:2) Either add the following to your xml file:
<Include file="Telepathy\Telepathy.xml"/>
::Or add this line to your toc file:
Telepathy\Telepathy.xml
:3) Add the following line to your toc:
SavedVariablesPerCharacter: Telepathy_Config
 
[[Category:Cosmos AddOns]]
[[Category:Function Libraries]]

Latest revision as of 04:48, 15 August 2023

Redirect to:

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:Telepathy&oldid=20643"