ZEssentials-ChatFilter

About

This add-on adds more features to your existing zEssentials plugin. You need zEssentials in order to use this plugin.

Category

  • Chat

Commands

Name Alias Description Since
/zechatfilter None Basic plugin information 1.0.0
/cfsettings <ad/censor> <add/remove> <Message> None Blocked phrases management 1.0.0
/globalmute /gmute Toggles globalmute (Enable/Disable chat for users) 1.0.0
/chatclear /cc Clear the chat 1.0.0

Permissions

Permission Node Description Permission Pack Since
ZEssentials.chat.use Access to send chat messages GENERAL 1.0.0
ZEssentials.command.cfsettings Access to the ChatFilter Management ADMINISTRATIVE 1.0.0
ZEssentials.command.globalmute Access to /globalmute MODERATIVE 1.0.0
ZEssentials.command.chatclear Access to /chatclear MODERATIVE 1.0.0
ZEssentials.bypass.chat.* Bypass all chat restrictions N/A 1.0.0
ZEssentials.bypass.chat.advertising Bypass chat restriction N/A 1.0.0
ZEssentials.bypass.chat.censor Bypass chat restriction N/A 1.0.0
ZEssentials.bypass.chat.spam Bypass chat restriction N/A 1.0.0
ZEssentials.bypass.chat.caps Bypass chat restriction N/A 1.0.0
ZEssentials.bypass.chat.same_message Bypass chat restriction N/A 1.0.0

Developer API

You can find all methods with their documentation in the at.rengobli.zechatfilter.manager.ChatManager.java class. The main instance of this plugin is called at.rengobli.zechatfilter.ZEChatFilter.java.

Methods
Name Type Description Parameter Return Since
isChatEnabled(); boolean Checks if the chat is enabled (GlobalMute active) N/A Chat enabled 1.0.0
setChatEnabled(); void Enable/Disable GlobalMute CommandSender cs, boolean value N/A 1.0.0
initialize(); void Update name, trigger, command and enable status for ChatCheckType.java enum from config.yml N/A N/A 1.0.0
isMessageOkay(); boolean Checks if the message fails a check, assigns warning if so (Check for a specific type) Player p, String message, ChatCheckType chatCheckType If message passes all checks 1.0.0
isMessageOkay(); boolean Checks if the message fails a check, assigns warning if so (Check for all types). Player p, String message If message passes all checks 1.0.0
warn(); void Check if the player has bypass permission. If not, increase warnings. If warnings >= trigger, issue command. Player p, String message, ChatCheckType chatCheckType N/A 1.0.0
passMessageCheck(); boolean Checks if the message passes all checks. (GlobalMute, Chat Filters). ChatPlayer cp, String message If the message passes all checks 1.0.0
isCaps(); boolean Checks if the message passes the caps filter ChatPlayer cp, String message Passes check 1.0.0
isSpam(); boolean Checks if the message passes the spam filter ChatPlayer cp, String message Passes check 1.0.0
isCensored(); boolean Checks if the message passes the censored phrases filter ChatPlayer cp, String message Passes check 1.0.0
isAdvertisement(); boolean Checks if the message passes the advertising filter ChatPlayer cp, String message Passes check 1.0.0
isSameMessage(); boolean Checks if the message passes the same message filter ChatPlayer cp, String message Passes check 1.0.0

File Configuration: config.yml

Settings

date_format
Choose the way that <date> is displayed in message logs for a player.
default: YYYY-MM-dd HH:mm:ss
antispam
Set how long players need to wait before sending another message.
default: 3
max_caps
Set the amount of uppercase letters a message shell contain at max.
default: 5

Debug mode for error handling

debug
If the plugin does not work as intended, try to figure out the problem with this mode before contacting the developer.
default: false