Quantcast
Download
(10 Kb)
Download
Updated: 04/22/21 01:33 PM
Compatibility:
Blackwood (7.0)
Flames of Ambition (6.3.5)
Updated:04/22/21 01:33 PM
Created:05/28/19 09:18 AM
Monthly downloads:132,723
Total downloads:688,626
Favorites:648
MD5:
Categories:Libraries, Data Mods
6.3.5
LibChatMessage  Popular! (More than 5000 hits)
Version: 1.2.0
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.

Custom Chat Links
Starting with version 1.2.0, the library offers a way for addons to send arbitrary data links in chat.

Known Issue/Drawback
  • If you register a chat link, but do not handle it, an error will occur, if the user clicks it.
  • Chat bubbles will show raw data. We can not modify them.
  • In order to display custom links in the chat input box, the lib sets all types of markup as allowed. this means that the text shown in the box may look different from what is actually being sent or visible to users without the library. For example a single | (pipe) character won't show until the message is sent and using color markup will change the text color in the input field, but show up as raw text in the chat once sent.

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>       [off/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()
SetTagPrefixMode
Sets the mode used for the proxy tag for addon messages.
Available modes are:
  1. TAG_PREFIX_OFF - Disables showing a tag. The long tag will still be stored in the history in case it is enabled.
  2. TAG_PREFIX_LONG - Prints the long tag provided by an addon in front of the message
  3. TAG_PREFIX_SHORT - Prints the short tag provided by an addon in front of the message
Code:
LibChatMessage:SetTagPrefixMode(mode)
GetTagPrefixMode
Returns the current message tag mode.
Code:
local mode = LibChatMessage:GetTagPrefixMode()
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()
RegisterCustomChatLink
Register a link type to be valid. Optional with a reformatter function.
All unregistered chat links will be change to an "unknown" link with all data stripped off upon receiving them from chat channel.
If someone is posting a chat link to someone, not having the addon it belongs to, a message is shown in the upper right corner instead of causing an error.

Code:
LibChatMessage:RegisterCustomChatLink(YOUR_LINK_TYPE)
LibChatMessage:RegisterCustomChatLink(YOUR_LINK_TYPE, reformatLinkFunc)
The reformatter has the following signature:
Code:
local function reformatLink(linkStyle, linkType, data, displayText)
    return ZO_LinkHandler_CreateLinkWithFormat(displayText, nil, linkType, linkStyle, data)
end
LibChatMessage:RegisterCustomChatLink(YOUR_LINK_TYPE, reformatLink)
displayText - Text shown to the user
linkTyype - Your link type (YOUR_LINK_TYPE)
linkStyle - Built-in values: LINK_STYLE_BRACKETS, LINK_STYLE_DEFAULT (number)
data - remaining part of the chat link containing the data your provided. (string)

The reformatter function can be used to localize the displayText.
Your chat link must provide at least one data column.

After registering a link type, you MUST add a link click handler.
See https://wiki.esoui.com/How_to_create_custom_links.

Example
Code:
function addon:OnLinkClicked(link, button, text, color, linkType, ...)
    if linkType ~= YOUR_LINK_TYPE then
        return
    end
    if button == MOUSE_BUTTON_INDEX_LEFT then
        -- Do your stuff
    elseif button == MOUSE_BUTTON_INDEX_MIDDLE then
        -- Do your stuff
    end
    return true -- link has been handled
end

function addon:InitLinkHandler()
    LINK_HANDLER:RegisterCallback(LINK_HANDLER.LINK_CLICKED_EVENT, self.OnLinkClicked, self)
    LINK_HANDLER:RegisterCallback(LINK_HANDLER.LINK_MOUSE_UP_EVENT, self.OnLinkClicked, self)
end
The value of the "unknown" link type can be found here:
LibChatMessage.UNKNOWN_LINK_TYPE
v1.2.0
- added support for custom chat links (thanks votan)
- updated for Blackwood

v1.1.3
- fixed error when events are received before saved variables are loaded

v1.1.2
- updated for chat system changes in game version 5.3.5 (temporary workaround has been removed)

v1.1.1
- fixed error when an addon tries to print a message during initialization

v1.1.0
- added temporary workaround for chat formatters not working. See description for details.
- updated for Harrowstorm

v1.0.1
- added missing IsLibrary flag
Archived Files (6)
File Name
Version
Size
Uploader
Date
1.1.3
5kB
sirinsidiator
03/02/20 01:26 PM
1.1.2
5kB
sirinsidiator
03/02/20 12:10 PM
1.1.1
6kB
sirinsidiator
02/25/20 01:55 PM
1.1.0
6kB
sirinsidiator
02/24/20 02:43 AM
1.0.1
5kB
sirinsidiator
06/01/19 05:15 AM
1.0.0
5kB
sirinsidiator
05/28/19 09:18 AM


Post A Reply Comment Options
Unread 05/14/21, 06:11 PM  
Rengaru

Forum posts: 0
File comments: 5
Uploads: 0
Originally Posted by sirinsidiator
I just installed both of these addons and don't get any errors. Please make sure that you have installed everything correctly and report any problems you have to the respective comment sections. Also try to be more specific and include as much detail as you can when you report a problem. Don't assume that what happens on your end happens on the author's end too.
I should have been more specific, sorry.
While using the current version (1.2.0) of this library together with SmartCast it will lock up any ground targeted skill, I can still press the button but the skill will not fire.
In-game I'm currently using the previous version (1.1.3) of this library and SmartCast works as expected.
Report comment to moderator  
Reply With Quote
Unread 05/14/21, 01:22 PM  
sirinsidiator
 
sirinsidiator's Avatar
AddOn Author - Click to view AddOns

Forum posts: 1478
File comments: 1041
Uploads: 38
I just installed both of these addons and don't get any errors. Please make sure that you have installed everything correctly and report any problems you have to the respective comment sections. Also try to be more specific and include as much detail as you can when you report a problem. Don't assume that what happens on your end happens on the author's end too.
__________________
https://www.imperialtradingcompany.eu/ - My Addons - The Vault (Early updates and experimental projects) - My patreon - My blog
>siri.exe MyAddon
Does your addon work? [y/n] n
There is a typo in there.
Report comment to moderator  
Reply With Quote
Unread 05/14/21, 10:40 AM  
Rengaru

Forum posts: 0
File comments: 5
Uploads: 0
Also SmartCast (https://www.esoui.com/downloads/info...dtargeting.htm) no longer works if you install the latest version of this library.
Report comment to moderator  
Reply With Quote
Unread 05/13/21, 05:42 AM  
Blathnir

Forum posts: 0
File comments: 2
Uploads: 0
UI errors occur with the LibChatMessage addon when the Socerer Helper is used, there is only a constant UI error and the Scoerer Helper addon is no longer executed
Report comment to moderator  
Reply With Quote
Unread 11/30/20, 04:49 AM  
sirinsidiator
 
sirinsidiator's Avatar
AddOn Author - Click to view AddOns

Forum posts: 1478
File comments: 1041
Uploads: 38
Re: Re: Re: Per chat-proxy ability to always include a prefix?

Originally Posted by marlonbrando
Originally Posted by sirinsidiator
Originally Posted by marlonbrando
I may be missing something but I don't see any way to add a prefix to messages without configuring it globally, i.e., LibChatMessage:SetTagPrefixMode(...). I'd like to be able to control this only for my add-on via something like chat:SetTagprefixMode(...) .

Is this possible or is something like this already there and I've missed it?
The tag prefix mode is a user setting, as such it's not supposed to be controlled by addons aside of when they offer a ui for the library. There is currently no way for a user to select it per addon either.
Ok. I'll add it manually. Thanks.
Before you add them manually I want you to consider why this setting was added in the first place. In the past I got asked by users if they can somehow hide the tags in chat, because they explicitly do not want them. The library will still show them by default, so your addon tags are visible for most users, but for the handful that doesn't like them and knows how to disable them via the lib there is now a way to hide them. As such you really should not circumvent this setting and manually add your tags to the message.
__________________
https://www.imperialtradingcompany.eu/ - My Addons - The Vault (Early updates and experimental projects) - My patreon - My blog
>siri.exe MyAddon
Does your addon work? [y/n] n
There is a typo in there.
Report comment to moderator  
Reply With Quote
Unread 11/29/20, 05:03 PM  
marlonbrando
AddOn Author - Click to view AddOns

Forum posts: 17
File comments: 125
Uploads: 5
Re: Re: Per chat-proxy ability to always include a prefix?

Originally Posted by sirinsidiator
Originally Posted by marlonbrando
I may be missing something but I don't see any way to add a prefix to messages without configuring it globally, i.e., LibChatMessage:SetTagPrefixMode(...). I'd like to be able to control this only for my add-on via something like chat:SetTagprefixMode(...) .

Is this possible or is something like this already there and I've missed it?
The tag prefix mode is a user setting, as such it's not supposed to be controlled by addons aside of when they offer a ui for the library. There is currently no way for a user to select it per addon either.
Ok. I'll add it manually. Thanks.
Report comment to moderator  
Reply With Quote
Unread 11/29/20, 12:17 PM  
sirinsidiator
 
sirinsidiator's Avatar
AddOn Author - Click to view AddOns

Forum posts: 1478
File comments: 1041
Uploads: 38
Re: Per chat-proxy ability to always include a prefix?

Originally Posted by marlonbrando
I may be missing something but I don't see any way to add a prefix to messages without configuring it globally, i.e., LibChatMessage:SetTagPrefixMode(...). I'd like to be able to control this only for my add-on via something like chat:SetTagprefixMode(...) .

Is this possible or is something like this already there and I've missed it?
The tag prefix mode is a user setting, as such it's not supposed to be controlled by addons aside of when they offer a ui for the library. There is currently no way for a user to select it per addon either.
__________________
https://www.imperialtradingcompany.eu/ - My Addons - The Vault (Early updates and experimental projects) - My patreon - My blog
>siri.exe MyAddon
Does your addon work? [y/n] n
There is a typo in there.
Report comment to moderator  
Reply With Quote
Unread 11/29/20, 12:10 PM  
marlonbrando
AddOn Author - Click to view AddOns

Forum posts: 17
File comments: 125
Uploads: 5
Per chat-proxy ability to always include a prefix?

I may be missing something but I don't see any way to add a prefix to messages without configuring it globally, i.e., LibChatMessage:SetTagPrefixMode(...). I'd like to be able to control this only for my add-on via something like chat:SetTagprefixMode(...) .

Is this possible or is something like this already there and I've missed it?
Report comment to moderator  
Reply With Quote
Unread 07/22/20, 02:56 AM  
sirinsidiator
 
sirinsidiator's Avatar
AddOn Author - Click to view AddOns

Forum posts: 1478
File comments: 1041
Uploads: 38
Re: Out of date, but needed as a lib for other mods?

Originally Posted by JLE
Some of my other mods are not working because they depend on this particular one (LibChatMessage) - or another one of yours (LibMapPing) - and the game is saying they are out of date.

What's wrong? Do they not yet work with Greymoor installed? When can an update be expected?

Other mods of yours also appear to be only up to date with the "Harrowstorm" expansion, not with the full "Greymoor" chapter.
https://www.esoui.com/portal.php?id=218&a=faq&faqid=152
__________________
https://www.imperialtradingcompany.eu/ - My Addons - The Vault (Early updates and experimental projects) - My patreon - My blog
>siri.exe MyAddon
Does your addon work? [y/n] n
There is a typo in there.
Report comment to moderator  
Reply With Quote
Unread 07/21/20, 07:38 PM  
JLE

Forum posts: 0
File comments: 7
Uploads: 0
Out of date, but needed as a lib for other mods?

Some of my other mods are not working because they depend on this particular one (LibChatMessage) - or another one of yours (LibMapPing) - and the game is saying they are out of date.

What's wrong? Do they not yet work with Greymoor installed? When can an update be expected?

Other mods of yours also appear to be only up to date with the "Harrowstorm" expansion, not with the full "Greymoor" chapter.
Report comment to moderator  
Reply With Quote
Unread 07/13/20, 08:34 PM  
TECHHNYNE

Forum posts: 0
File comments: 4
Uploads: 0
for some reason i cant get any of these addons to register they are all in my addon DIR
https://imgur.com/a/1PleUjN

Last edited by TECHHNYNE : 07/13/20 at 08:34 PM.
Report comment to moderator  
Reply With Quote
Unread 06/06/20, 10:41 AM  
drsneg

Forum posts: 0
File comments: 2
Uploads: 0
Re: Re: problem

Originally Posted by sirinsidiator
Originally Posted by drsneg
i installed the lastest version of this library. 1.1.3.
But in no one modes is not working. Please help. What i doing wrong?

Sorry for russian language in gui.
You need to check the checkbox on the top right and reload the ui. Then it should work.
Thanks! It work!
Report comment to moderator  
Reply With Quote
Unread 06/06/20, 09:48 AM  
sirinsidiator
 
sirinsidiator's Avatar
AddOn Author - Click to view AddOns

Forum posts: 1478
File comments: 1041
Uploads: 38
Re: problem

Originally Posted by drsneg
i installed the lastest version of this library. 1.1.3.
But in no one modes is not working. Please help. What i doing wrong?

Sorry for russian language in gui.
You need to check the checkbox on the top right and reload the ui. Then it should work.
__________________
https://www.imperialtradingcompany.eu/ - My Addons - The Vault (Early updates and experimental projects) - My patreon - My blog
>siri.exe MyAddon
Does your addon work? [y/n] n
There is a typo in there.
Report comment to moderator  
Reply With Quote
Unread 06/06/20, 07:24 AM  
drsneg

Forum posts: 0
File comments: 2
Uploads: 0
problem

i installed the lastest version of this library. 1.1.3.
But in no one modes is not working. Please help. What i doing wrong?

Sorry for russian language in gui.
Last edited by drsneg : 06/06/20 at 07:25 AM.
Report comment to moderator  
Reply With Quote
Unread 05/27/20, 02:42 AM  
sirinsidiator
 
sirinsidiator's Avatar
AddOn Author - Click to view AddOns

Forum posts: 1478
File comments: 1041
Uploads: 38
Originally Posted by Casterial
Code:
user:/AddOns/LibChatMessage/LibChatMessage.lua:528: function expected instead of nil
stack traceback:
user:/AddOns/LibChatMessage/LibChatMessage.lua:528: in function 'ReinitializeChatFormatters'
user:/AddOns/LibChatMessage/LibChatMessage.lua:586: in function 'func'
 EsoUI/Libraries/Globals/globalapi.lua:216: in function '(anonymous)'
This error points to an empty line in the code of the latest version. Make sure you update your addons!
__________________
https://www.imperialtradingcompany.eu/ - My Addons - The Vault (Early updates and experimental projects) - My patreon - My blog
>siri.exe MyAddon
Does your addon work? [y/n] n
There is a typo in there.
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.