[Tutorial] Chat management (muting, etc)

Hello there,

This tutorial will be about muting players from speaking, and blocking all caps messages.
NOTES:

• Make sure to register the command in the plugin.yml file!
• Make sure to create a configuration file.
• When the plugin loads, the configuration will be empty. To make the file have something in it: De-op yourself, then type /mute <your name here> in the console. The config file will update, and if you reload the server and try to speak, you won't be able to, ONLY if you are muted. Then to unmute yourself, just type /mute <your name here> again.

UPCOMING:
- Censoring words
- Keep players from spamming symbols such as $, %, etc
- Chat cooldown


[1]: Muting
You will first need a class that:
- Extends the JavaPlugin class
- Implements the Listener class
- Implements the CommandExecutor class

Once you have that, let's get started.

First off, the mute command. I will paste the code for it and add comments to help you understand it better.

CODE:

Code:java

 @Override
public boolean onCommand(org.bukkit.command.CommandSender s, org.bukkit.command.Command cmnd, String alias, String[] args) {
org.bukkit.command.CommandSender p = s;
if (alias.equalsIgnoreCase("mute")) {
if (args.length < 1) {
s.sendMessage(ChatColor.translateAlternateColorCodes('&', "&cUsage: /mute <player>"));
} else if (args.length == 1) {
String name = args[0];//The name is the first argument
org.bukkit.entity.Player target = org.bukkit.Bukkit.getPlayer(name);//Get the player by the name of the first argument
 
if (target != null && !target.isOp() && !target.getName().equals(s.getName())) {//Check to see if the target: A- Exists, B- Is not an op, C- Their name does not equal the name of the sender
if (!muted.containsKey(target)) {
muted.put(target, target);//We don't really need this, just there to be safe.
s.sendMessage(ChatColor.GREEN + "You have muted " + args[0] + ".");//Muted the player
target.sendMessage(ChatColor.translateAlternateColorCodes('&', "&6You have been muted by &c" + p.getName()));
getConfig().set("Players." + target.getName() + ".Muted", true);//Edit the boolean "Muted" in the key with the player's name and set it to true
saveConfig();//Save the config
} else {
muted.remove(target);//We don't really need this, just there to be safe.
s.sendMessage(ChatColor.GREEN + "You have unmuted " + args[0] + ".");//Unmuted a player
target.sendMessage(ChatColor.translateAlternateColorCodes('&', "&6You have been unmuted by &c" + p.getName()));
getConfig().set("Players." + target.getName() + ".Muted", false);//Edit the boolean "Muted" in the key with the player's name and set it to false
saveConfig();//Save the config
 
}
 
} else {
if (target != null && target.isOp()){
s.sendMessage(ChatColor.RED + "You may not mute operators.");
}
if (target != null &&target.getName().equals(s.getName())){
s.sendMessage(ChatColor.RED + "You may not mute yourself.");
}
}
return true;
}
return true;
}
return true;
}

Next up, the listener.

Code:java

 @EventHandler//Good ol' @EventHandler annotation
public void onPlayerChat(org.bukkit.event.player.AsyncPlayerChatEvent e) {//Listens for the chat event
org.bukkit.entity.Player p = e.getPlayer();//gets the player
if (getConfig().getBoolean("Players." + p.getName() + ".Muted")) {//checks the boolean "Muted" in the key with the player's name
e.setCancelled(true);//Cancels the event
p.sendMessage(org.bukkit.ChatColor.RED + "You may not talk while muted.");//Pretty obvious what this does
}
 
}

And finally, the onEnable method:

Code:java

public HashMap<Player, Player> muted = new HashMap<Player, Player>(); //Unneeded hashmap, it's there from a while ago
 
@Override
public void onEnable() {
org.bukkit.plugin.PluginManager pm = org.bukkit.Bukkit.getPluginManager();//Get the pluginmanager
pm.registerEvents(this, this);//Register events
this.saveDefaultConfig();//Save the default config
getCommand("mute").setExecutor(this);//Set the executor of the command "/mute" to this class
String MUTE_PERM_MESSAGE = "[Mute] You don't have permission.";//permission message
getCommand("mute").setPermissionMessage(org.bukkit.ChatColor.RED + MUTE_PERM_MESSAGE);//set the permission message
getCommand("mute").setPermission("chattools.mute");//set the permission
pm.addPermission(new org.bukkit.permissions.Permission("chattools.mute"));//add the permission
pm.getPermission("chattools.mute").setDefault(PermissionDefault.OP);//set the "default" property for the permission to operators only
saveConfig();//save the config
}

[2] Blocking all caps
You can put this code in the event handler for the AsyncPlayerChatEvent from above.

The code is:

Code:java

String m = e.getMessage();
if (m.toUpperCase().equals(m)){
e.setCancelled(true);
p.sendMessage(org.bukkit.ChatColor.RED + "You may not talk in all caps.");
}

So now the event handler will look like:

Code:java

 
@EventHandler
public void onPlayerChat(org.bukkit.event.player.AsyncPlayerChatEvent e) {
org.bukkit.entity.Player p = e.getPlayer();
String m = e.getMessage();
 
if (m.toUpperCase().equals(m)) {
e.setCancelled(true);
p.sendMessage(org.bukkit.ChatColor.RED + "You may not talk in all caps.");
}
if (getConfig().getBoolean("Players." + p.getName() + ".Muted")) {
e.setCancelled(true);
p.sendMessage(org.bukkit.ChatColor.RED + "You may not talk while muted.");
}
 
}
 

I hope this helps!

 

Seems like a great tut!

Show Spoiler Hide Spoiler

Got a message saying I was tagged in this post. Am I missing something?

 

Oh yeah I was using the org.bukkit.event.EventHandler in the annotation, so it tagged you.

Show Spoiler Hide Spoiler

never knew that there was an actual user named "Org"

 

Bump, hope this is useful!

 

I don't see why you're using a HashMap, when you could be doing an ArrayList, not to mention, you should be doing UUID's since name changing will happen in 1.8

Also, why use a HashMap when you're storing it in the config.yml?

 

why do you use a HashMap and a config? In the end, you just end up using the config.

I tried to clean up some of your code, changed a few variables here and there. I think you had a right idea, but you over-did it a bit and had a lot of messy / unused code.

(I only did the first class, the event for it seems well and I'm too tired to help you out on the caps one)

Code:java

 
import org.bukkit.Bukkit;
import org.bukkit.ChatColor;
import org.bukkit.configuration.Configuration;
import org.bukkit.entity.Player;
 
public class Snippet {
    public boolean onCommand(org.bukkit.command.CommandSender s, org.bukkit.command.Command cmnd, String alias, String[] args) {
        Player player = (Player) s;
        if (alias.equalsIgnoreCase("mute")) {
            if (args.length < 1) {
 
                player.sendMessage(ChatColor.RED + "Usage: /mute <player>");
            } else if (args.length == 1) {
                String name = args[0];
                Player target = Bukkit.getPlayer(name);
 
                if(target != null){
                    if (!target.isOp() && !target.getName().equals(player.getName())) {
if (getConfig().get("Players." + target.getName() + ".Muted") == null || getConfig().getBoolean("Players." + target.getName() + ".Muted") == false) {
                            player.sendMessage(ChatColor.GREEN + "You have muted " + args[0] + ".");
                            target.sendMessage(ChatColor.RED + "You have been muted by " + player.getName());
                            getConfig().set("Players." + target.getName() + ".Muted", true);
                            saveConfig();
                        } else {
                            player.sendMessage(ChatColor.GREEN + "You have unmuted " + args[0] + ".");
                            target.sendMessage(ChatColor.GREEN + "You have been unmuted by " + player.getName());
                            getConfig().set("Players." + target.getName() + ".Muted", false);
                            saveConfig();
 
                        }
 
                    } else {
                        if (target.isOp()){
                            player.sendMessage(ChatColor.RED + "You may not mute operators.");
                        }
                        if (target.getName().equals(s.getName())){
                            player.sendMessage(ChatColor.RED + "You may not mute yourself.");
                        }
                    }
                }else{
                    player.sendMessage(ChatColor.RED + "The specified player is offline or does not exist");
                }
            }
        }
        return false;
    }
}

 

Thanks I'll try that later, I just use HashMaps for now. I'll change that when I have time

 

start from learning about code formatting and usage of code tags.

hardcoded string constants also bad move.

 

I literally have no idea what you just said... anyway, I have my way of doing things. I used the code tags correctly as I can see...

 

The formatting breaks when you edit with java syntax.

And not knowing what "hardcoded string constants" means but at the same time making a tutorial seems like a bad combination, to be quite honest.