-
Notifications
You must be signed in to change notification settings - Fork 8
Chatbase Extended
Here you will find the documentation on the features in the Chat Base part of the framework.
Documentation may be incomplete and might need additions, we will update this when we can.
Chat Base Extended is a bunch of methods designed for making using the Chat Base much easier and simpler by using a complete method instead.
Chat Base Extended is included in the ChatBase Namespace.
All Information on you might need can be found on the Chat Base docs, be sure to look at them as they contain detailed information which is crucial in using these methods.
Usage:
using Eco.EM.Framework.ChatBase;Below are all the Methods you can use listed in Alphabetical order
Each Method is named the Same as its counter part in the Chat Base for clarity, so i won't be providing a full explanation on each Method as the explanations are available on the Chat Base Web Page located here: Chat Base
Every Method Starts With CB to prevent conflicts just in case you wish to make your own custom wrappers as well.
Here is a list of all the methods you can use For the ChatBase.Announcement sending method
- ChatBaseExtended.CBAnnouncement(string content, bool sendToAll, bool sendToChat)
- ChatBaseExtended.CBAnnouncement(string title, string content, bool sendToAll, bool sendToChat)
- ChatBaseExtended.CBAnnouncement(string title, string content, MessageType messageType, bool sendToAll, bool sendToChat)
SendToAll and SendToChat are both Optional Parameters and do not need to be added/used, for more information See ChatBase.Announcement
Here is a list of all the methods you can use For the ChatBase.Chat sending Method
- ChatBaseExtended.CBChat(string Content);
- ChatBaseExtended.CBChat(string content, MessageType messageType);
- ChatBaseExtended.CBChat(string content, DefaultChatTags defaultChatTags);
- ChatBaseExtended.CBChat(string content, MessageType messageType, DefaultChatTags defaultChatTags)
- ChatBaseExtended.CBChat(string Content, User user)
- ChatBaseExtended.CBChat(string content, User user, MessageType messageType)
- ChatBaseExtended.CBChat(string content, User user, DefaultChatTags defaultChatTags)
- ChatBaseExtended.CBChat(string content, User user, MessageType messageType, DefaultChatTags defaultChatTags)
- ChatBaseExtended.CBChat(string Content, Player player)
- ChatBaseExtended.CBChat(string content, Player player, MessageType messageType)
- ChatBaseExtended.CBChat(string content, Player player, DefaultChatTags defaultChatTags)
- ChatBaseExtended.CBChat(string content, Player player, MessageType messageType, DefaultChatTags defaultChatTags)
For more information See ChatBase.Chat
Here is a list of all the methods you can use For the ChatBase.Error sending method
- ChatBaseExtended.CBError(string content)
- ChatBaseExtended.CBError(string content, User user)
- ChatBaseExtended.CBError(string content, Player player)
For more information See ChatBase.Error
Here is a list of all the methods you can use For the ChatBase.Info sending method
- ChatBaseExtended.CBInfo(string content)
- ChatBaseExtended.CBInfo(string content, User user)
- ChatBaseExtended.CBInfo(string content, Player player)
For more information See ChatBase.Info
Here is a list of all the methods you can use For the ChatBase.InfoBox sending method
- ChatBaseExtended.CBInfoBox(string content)
- ChatBaseExtended.CBInfoBox(string content, User user)
- ChatBaseExtended.CBInfoBox(string content, Player player)
For more information See ChatBase.InfoBox
Here is a list of all the methods you can use For the ChatBase.InfoPane sending method
- ChatBaseExtended.CBInfoPane(string title, string content, bool sendToChat)
- ChatBaseExtended.CBInfoPane(string title, string content, bool messageType, bool sendToChat)
- ChatBaseExtended.CBInfoPane(string title, string content, bool messageType, bool tempMessage, bool sendToChat)
- ChatBaseExtended.CBInfoPane(string title, string content, User user, bool sendToChat)
- ChatBaseExtended.CBInfoPane(string title, string content, User user, bool messageType, bool sendToChat)
- ChatBaseExtended.CBInfoPane(string title, string content, User user, bool messageType, bool tempMessage, bool sendToChat)
- ChatBaseExtended.CBInfoPane(string title, string content, Player player, bool sendToChat)
- ChatBaseExtended.CBInfoPane(string title, string content, Player player, bool messageType, bool sendToChat)
- ChatBaseExtended.CBInfoPane(string title, string content, Player player, bool messageType, bool tempMessage, bool sendToChat)
SendToChat is an optional Parameter and doesn't need to be there, For more information See ChatBase.InfoPane
Here is a list of all the methods you can use For the ChatBase.Mail sending method
- ChatBaseExtended.CBMail(string content)
- ChatBaseExtended.CBMail(string content, string tag)
- ChatBaseExtended.CBMail(string content, User user)
- ChatBaseExtended.CBMail(string content, string tag, User user)
- ChatBaseExtended.CBMail(string content, Player player)
- ChatBaseExtended.CBMail(string content, string tag, Player player)
For more information See ChatBase.Mail
Here is a list of all the methods you can use For the ChatBase.Mail sending method
- ChatBaseExtended.CBMessage(string content)
- ChatBaseExtended.CBMessage(string content, MessageType messageType)
- ChatBaseExtended.CBMessage(string content, DefaultChatTags defaultChatTags)
- ChatBaseExtended.CBMessage(string content, MessageCategory messageCategory, DefaultChatTags defaultChatTags)
- ChatBaseExtended.CBMessage(string content, MessageCategory messageCategory, DefaultChatTags defaultChatTags, MessageType messageType)
- ChatBaseExtended.CBMessage(string title, string content)
- ChatBaseExtended.CBMessage(string title, string content, MessageType messageType)
- ChatBaseExtended.CBMessage(string content, User user)
- ChatBaseExtended.CBMessage(string content, User user, MessageType messageType)
- ChatBaseExtended.CBMessage(string content, User user, DefaultChatTags defaultChatTags)
- ChatBaseExtended.CBMessage(string content, User user, MessageCategory messageCategory, DefaultChatTags defaultChatTags)
- ChatBaseExtended.CBMessage(string content, User user, MessageCategory messageCategory, DefaultChatTags defaultChatTags, MessageType messageType)
- ChatBaseExtended.CBMessage(string title, string content, User user)
- ChatBaseExtended.CBMessage(string content, Player player)
- ChatBaseExtended.CBMessage(string content, Player player, MessageType messageType)
- ChatBaseExtended.CBMessage(string content, Player player, DefaultChatTags defaultChatTags)
- ChatBaseExtended.CBMessage(string content, Player player, MessageCategory messageCategory, DefaultChatTags defaultChatTags)
- ChatBaseExtended.CBMessage(string content, Player player, MessageCategory messageCategory, DefaultChatTags defaultChatTags, MessageType messageType)
- ChatBaseExtended.CBMessage(string title, string content, Player player)
For more information See ChatBase.Message
Here is a list of all the methods you can use For the ChatBase.OkBox sending method
- ChatBaseExtended.CBOkBox(string content)
- ChatBaseExtended.CBOkBox(string content, User user)
- ChatBaseExtended.CBOkBox(string content, Player player)
For more information See ChatBase.OkBox
Here is a list of all the methods you can use For the ChatBase.Warning sending method
- ChatBaseExtended.CBWarning(string content)
- ChatBaseExtended.CBWarning(string content, User user)
- ChatBaseExtended.CBWarning(string content, Player player)
For more information See ChatBase.Warning
Here is a list of all the methods you can use For the ChatBase.Whisper sending method
- ChatBaseExtended.CBWhisper(string content)
- ChatBaseExtended.CBWhisper(string content, User user)
- ChatBaseExtended.CBWhisper(string content, Player player)
For more information See ChatBase.Whisper