Quantcast
Download
(5 Kb)
Download
Updated: 06/01/19 05:15 AM
Compatibility:
Elsweyr (5.0.5)
Updated:06/01/19 05:15 AM
Created:05/28/19 09:18 AM
Monthly downloads:4,228
Total downloads:10,201
Favorites:28
MD5:
Categories:Libraries, Data Mods
LibChatMessage  Popular! (More than 5000 hits)
Version: 1.0.1
by: sirinsidiator [More]
For years addon authors have abused the debug methods d(), df() and CHAT_SYSTEM:AddMessage() to show messages in chat or even added text directly to the chat buffer, preventing other addons from interacting with the output. LibChatMessage offers an easy alternative that uses the same method as the vanilla UI to print system messages.

Features

Chat Messages
The main purpose of the library is to provide an easy API that can be used to print messages in chat. This is done via so called chat proxy objects. Each addon can create their own proxy and call the Print and Printf method (similar to d() and df()).

Addon Tag
The library will automatically prefix each message with a tag provided to each chat proxy instance by their addon. Users can choose if they want the tag to be the full addon name or a shortened string.

Time Prefix
The library can also print the current time in front of each chat message. This is disabled by default to avoid compatibility issues with other chat addons, but can be enabled via the settings explained below.

Chat History
Another feature of the library is to store all incoming chat messages and restore them again at UI load. This is also disabled by default to avoid compatibility problems (especially with pChat). Unlike with pChat the history is saved in raw form, meaning that any modifications to the message made by addons are not stored and instead applied when the messages are restored. This also means that information like the guild name is lost when the player leaves a guild and can lead to restored messages showing no or even a different guild name.

Quick Start
Add LibChatMessage as a dependency to your addon manifest:
Code:
## DependsOn: LibChatMessage
Afterwards you can create a chat proxy and print messages like so:
Lua Code:
  1. local chat = LibChatMessage("MyAddon", "MA") -- long and short tag to identify who is printing the message
  2. chat:Print("Simple message") -- instead of d()
  3. chat:Printf("Formatted %s", "message") -- instead of df()
  4. chat:SetTagColor("ff0000"):Print("Message with a different tag color") -- To change the tag color for e.g. warnings. The message itself can be colored with a color tag, although I can't really recommend doing that
  5. chat:SetEnabled(false) -- in case the output of this ChatProxy should be enabled. Could be used when a settings is supposed to disable chat messages for an addon
  6. chat:Print("Ignored message") -- won't show up

Settings
LibChatMessage offers several settings to allow players to control the look of the output. The settings can be changed via the "/chatmessage" slash command, or via the libraries API. Using the slash command with an invalid command will print the following message to chat:
Code:
/chatmessage <command> [argument]
- <time>      [on/off]
-     Enables or disables the time prefix
- <chat>      [on/off]
-     Controls the time prefix on regular chat
- <format>    [auto/12h/24h]
-     Changes the used time format
- <tag>       [short/long]
-     Changes the length of the used tag
- <history>   [on/off]
-     Restore old chat after login
- <age>       [seconds]
-     The maximum age of restored chat
-
- Example: /chatmessage tag short
Using a command without an argument will print the current state of the setting to chat.

API Reference

Create
Returns a new instance of ChatProxy with the given tags.
Code:
local chat = LibChatMessage.Create(longTag, shortTag)
or
Code:
local chat = LibChatMessage(longTag, shortTag)
ChatProxy:SetTagColor
Sets the color of the message tag for the next printed message (resets afterwards). Can be either a hex string ("ff0000") or a ZO_ColorDef object. Returns the ChatProxy instance so the call can be chained as shown in the quick start example.
Code:
local chat = chat:SetTagColor(color)
ChatProxy:Print
Method to a print regular messages to chat. The message will automatically be prefixed with the time and tag based on user preferences.
Code:
chat:Print(message)
ChatProxy:Printf
Method to print a message formatted via string.format to chat. The message will automatically be prefixed with the time and tag based on user preferences.
Code:
chat:Printf(formatString, ...)
ChatProxy:SetEnabled
Setter to turn this proxy off, so it no longer prints anything to chat when one of its methods is called. Can be used to easily enable or disable chat messages for an addon based on user preferences.
Code:
chat:SetEnabled(enabled)
ClearChat
Removes all messages from all chat windows.
Code:
LibChatMessage:ClearChat()
ClearHistory
Removes all stored messages from the chat history.
Code:
LibChatMessage:ClearHistory()
GetHistory
Returns the current chat history table.
Code:
LibChatMessage:GetHistory()
SetTimePrefixEnabled
Sets the time prefix feature enabled or disabled. Disabled by default as it may cause problems with other chat addons that have similar features.
Code:
LibChatMessage:SetTimePrefixEnabled(enabled)
IsTimePrefixEnabled
Returns true if the time prefix feature is enabled.
Code:
local enabled = LibChatMessage:IsTimePrefixEnabled()
SetRegularChatMessageTimePrefixEnabled
Sets the time prefix feature for player chat channels enabled or disabled. Enabled by default, but only counts if the time prefix feature itself is turned on.
Code:
LibChatMessage:SetTimePrefixEnabled(enabled)
IsRegularChatMessageTimePrefixEnabled
Returns true if the time prefix feature is enabled for player chat channels.
Code:
local enabled = LibChatMessage:IsTimePrefixEnabled()
TIME_FORMATS
An array containing the time formats passed to os.date for the time prefix.
  1. TIME_FORMAT_AUTO = "[%X]" - uses locale dependent formatting
  2. TIME_FORMAT_12 = "[%I:%M:%S %p]" - 12h time format
  3. TIME_FORMAT_24 = "[%T]" - 24h time format (ISO 8601)

SetTimePrefixFormat
Sets the format for the time prefix feature. Can be either one contained in TIME_FORMATS, or a custom format string. Custom strings should be wrapped in brackets.
Code:
LibChatMessage:SetTimePrefixFormat(format)
GetTimePrefixFormat
Returns the time prefix formatting string.
Code:
local format = LibChatMessage:GetTimePrefixFormat()
SetShortTagPrefixEnabled
Enables or disables the use of the short proxy tag for addon messages.
Code:
LibChatMessage:SetShortTagPrefixEnabled(enabled)
IsShortTagPrefixEnabled
Returns true if the short message tag is enabled.
Code:
local enabled = LibChatMessage:IsShortTagPrefixEnabled()
SetChatHistoryEnabled
Sets the chat history feature enabled or disabled on the next UI load. This feature is not compatible with pChat and disabled by default.
Code:
LibChatMessage:SetChatHistoryEnabled(enabled)
IsChatHistoryEnabled
Returns true if the message history will be enabled on the next UI load.
Code:
local enabled = LibChatMessage:IsChatHistoryEnabled()
IsChatHistoryActive
Returns true if the message history is active right now.
Code:
local enabled = LibChatMessage:IsChatHistoryActive()
SetChatHistoryMaxAge
Sets the maximum age for chat messages to be restored on UI load in seconds. Default is 3600s (= 1h).
Code:
LibChatMessage:SetChatHistoryMaxAge(maxAge)
GetChatHistoryMaxAge
Returns the maximum age for chat messages in the history.
Code:
local maxAge = LibChatMessage:GetChatHistoryMaxAge()
v1.0.1
- added missing IsLibrary flag
Archived Files (1)
File Name
Version
Size
Uploader
Date
1.0.0
5kB
sirinsidiator
05/28/19 09:18 AM


Post A Reply Comment Options
Unread 11/13/19, 08:15 PM  
silvereyes
 
silvereyes's Avatar
AddOn Author - Click to view AddOns

Forum posts: 58
File comments: 264
Uploads: 14
fwiw, here is the extended ChatProxy class that's now included with Postmaster and Unboxer:
Lua Code:
  1. --[[
  2.      A customized version of the ChatProxy class from LibChatMessage
  3. ]]--
  4.  
  5. local addon = Postmaster
  6. local class = addon.classes
  7. local debug = false
  8. local TAG_FORMAT = "[%s]"
  9. local COLOR_FORMAT = "|c%s%s|r"
  10. local baseClass = getmetatable(LibChatMessage("__", "_"))
  11.  
  12. class.ChatProxy = baseClass:Subclass()
  13.  
  14. function class.ChatProxy:New(...)
  15.     local chat = baseClass.New(self, ...)
  16.     chat.retainTagColor = true
  17.     chat.tagSuffix = ""
  18.     return chat
  19. end
  20.  
  21. --- Internal method to retrieve the colored tag.
  22. --- @return string, the colored tag
  23. function class.ChatProxy:GetTag()
  24.     local tag
  25.     if self.shortTagPrefixEnabled ~= nil then
  26.         tag = self.shortTagPrefixEnabled and self.shortTag or self.longTag
  27.     else
  28.         tag = LibChatMessage.settings.shortTagPrefixEnabled and self.shortTag or self.longTag
  29.     end
  30.     tag = tag .. self.tagSuffix
  31.     tag = TAG_FORMAT:format(tag)
  32.     if(self.tagColor) then
  33.         tag = COLOR_FORMAT:format(self.tagColor, tag)
  34.         if not self.retainTagColor then
  35.             self.tagColor = nil
  36.         end
  37.     end
  38.     return tag
  39. end
  40.  
  41. function class.ChatProxy:SetRetainTagColor(retainTagColor)
  42.     self.retainTagColor = retainTagColor
  43. end
  44.  
  45. function class.ChatProxy:SetLongTag(longTag)
  46.     self.longTag = longTag
  47. end
  48.  
  49. function class.ChatProxy:SetShortTag(shortTag)
  50.     self.shortTag = shortTag
  51. end
  52.  
  53. function class.ChatProxy:SetShortTagPrefixEnabled(shortTagPrefixEnabled)
  54.     self.shortTagPrefixEnabled = shortTagPrefixEnabled
  55. end
  56.  
  57. function class.ChatProxy:SetTagSuffix(tagSuffix)
  58.     self.tagSuffix = tagSuffix
  59. end

The tag suffix is something I use in Postmaster to append the account name of the person who sent the attachments to the tag.
Last edited by silvereyes : 11/13/19 at 10:45 PM.
Report comment to moderator  
Reply With Quote
Unread 11/07/19, 06:48 PM  
silvereyes
 
silvereyes's Avatar
AddOn Author - Click to view AddOns

Forum posts: 58
File comments: 264
Uploads: 14
Also, if it's not too much to ask, I would also love a couple more options on the ChatProxy class:
  • The option to not clear self.tagColor every time GetTag() is called
  • The ability to change self.shortTag and self.longTag after instantiation
Report comment to moderator  
Reply With Quote
Unread 11/07/19, 10:35 AM  
silvereyes
 
silvereyes's Avatar
AddOn Author - Click to view AddOns

Forum posts: 58
File comments: 264
Uploads: 14
Originally Posted by sirinsidiator
Addons then can set their own preference in some way I haven't thought about yet and users will be able to overwrite it. What do you think?
The ability to configure either long or short tags on a ChatProxy instance and toggle it live would be ideal for me. I don't know if it needs to be the default functionality, though. Maybe have it default to the global toggle if not specified, but if explicitly set by the addon to be long or short, then use that. I don't think it needs to be any more complicated than that.
Report comment to moderator  
Reply With Quote
Unread 11/07/19, 06:06 AM  
sirinsidiator
 
sirinsidiator's Avatar
AddOn Author - Click to view AddOns

Forum posts: 1290
File comments: 811
Uploads: 34
Originally Posted by silvereyes
I'm definitely considering adding LibChatMessage to my addons, but I have a problem.

Most of my addons already allow toggling between long and short prefixes in addon settings, but LibChatMessage only offers a global toggle, hidden in a slash command that users will never see.

Do you have any suggestions on how to handle this without completely confusing users?
You are actually the second person who asks something similar in just a week.
I've thought a bit about the issue and guess I'll change the tag setting to allow four values:
  • Auto - will be the new default and use whatever an addon specifies
  • Long - forces the full length tag regardless of addon preference
  • Short - same as long, but short
  • None - completely hides the tag from the chat messages
Addons then can set their own preference in some way I haven't thought about yet and users will be able to overwrite it. What do you think?
__________________
Like what I do? Support me on Patreon!
>siri.exe MyAddon
Does your addon work? [y/n] n
There is a typo in there.
Last edited by sirinsidiator : 11/07/19 at 06:07 AM.
Report comment to moderator  
Reply With Quote
Unread 11/06/19, 10:54 PM  
silvereyes
 
silvereyes's Avatar
AddOn Author - Click to view AddOns

Forum posts: 58
File comments: 264
Uploads: 14
I'm definitely considering adding LibChatMessage to my addons, but I have a problem.

Most of my addons already allow toggling between long and short prefixes in addon settings, but LibChatMessage only offers a global toggle, hidden in a slash command that users will never see.

Do you have any suggestions on how to handle this without completely confusing users?
Report comment to moderator  
Reply With Quote
Post A Reply



Category Jump:

Support AddOn Development!

You have just downloaded by the author . If you like this AddOn why not consider supporting the author? This author has set up a donation account. Donations ensure that authors can continue to develop useful tools for everyone.