[Micro-event] Player chat Mentioner/Tagger.

Hi Peeps,
After spending time looking at the forums, there are still people wanting to know how to send a notification style message to someone when they are mentioned in chat. So I did some research and wrote up this really tiny event, to show you the simplest way it can be done!

Code:java

  @EventHandler
  public void onNameMention(final AsyncPlayerChatEvent event)
  {
    final Player player = event.getPlayer();
    for (final Player p : Bukkit.getOnlinePlayers())
      if (event.getMessage().contains("@" + p.getName())) {
            p.playNote(p.getLocation(), Instrument.PIANO, Note.natural(1, Note.Tone.A));       
      }
  }
 

So there we go, its shockingly simple. Edit this line:

Code:java

 if (event.getMessage().contains("@" + p.getName())) {

to your liking. As this looks for an "at" sign before the name in order to tag the player.

 

Could be far better... with this if someone said a word that contains the players name, it would still ping the player.

 

I'm afraid you're very wrong. Take my name for example, why would you say something like hercreepers84dfr??? Say if someone's name was chocolate123, if you said chocolate it wouldn't tag them!!! It would need the full name. Plus, why would you put an at symbol in front of it anyway?

 

You should also make it so that you can Tab-Complete with the @ tags. So that If I typed boba then pressed TAB, it would autocomplete to bobacadodl

 

Sounds great. How would I do that?

 

You could use the PlayerChatTabCompleteEvent for this.

 

Sounds straightforward. Ill take a look.

 

creepers84
I like the idea of having it so you can press tab, or you can just add check so if it is only @97Wa it will tag me, but if it is @asd97Wa it wouldn't. Maybe match the first few letters? As well as tab support?

 

Good idea. Gonna do some searching...

 

Also, your current code is case sensitive. Make sure you are making the message to lower case, and their name to lower case.

Also, I think the PLING instead of PIANO sound would work better

 

How would the lower case system work?
EDIT: NVM. Got it to work.

 

Why do you think that calling non-threadsafe methods out of an async event might be a good idea?!

 

In what way is it "non-threadsafe" ?

 

The wiki is pretty clear: "The Bukkit API, with the exception of the scheduler package, is not thread safe nor guaranteed to be thread safe." That said, there are some methods that are threadsafe (as of writing) even through this is not guaranteed, but I highly doubt that player.getLocation() and player.playNote() are.

For your purpose you could simply use the PlayerChatEvent witch is executed in the main thread (and is only deprecated to inform developers about the AsyncPlayerChatEvent - bukkit logic, I suppose).

Edit: Additionally, for the lower-case-check, Apache Commons (bundled with bukkit) contains a nice set of StringUtils, among others StringUtils.containsIgnoreCase(String str, String searchStr) that might help.

 

Ok... I kinda get your point... but then... meh.

Good idea about implementing apache though

EDIT by Moderator: merged posts, please use the edit button instead of double posting.

 

Any support for chat colour codes? It will be a bit difficult having to ChatColor.stripColor then get the index, etc. but is there a way you, or anyone else could do this?

 

creepers84 Try it

Code:java

@EventHandler
private final void onPlayerChatTabComplete(final PlayerChatTabCompleteEvent event) {
    final String token = event.getLastToken();
    if(token.startsWith("@")) {
        final Collection<String> autoCompletions = event.getTabCompletions();
        autoCompletions.clear();
        final String begin = token.replaceAll("@", "").toLowerCase();
        for(final Player player : Bukkit.getOnlinePlayers()) {
            final String playerName = player.getName();
            if(playerName.toLowerCase().startsWith(begin)) {
                autoCompletions.add("@" + playerName);
            }
        }
    }
}
 
@EventHandler
private final void onAsyncPlayerChat(final AsyncPlayerChatEvent event) {
    for(final Player player : Bukkit.getOnlinePlayers()) {
        final String message = event.getMessage();
        final String playerName = "@" + player.getName();
        if(StringUtils.containsIgnoreCase(message, playerName)) {
            event.setMessage(message.replaceAll(playerName, ChatColor.GRAY + playerName));
            player.playNote(player.getLocation(), Instrument.PIANO, Note.natural(1, Note.Tone.A));
        }
    }
}

 

Brilliant Thanks Skyost!

 

Why is everything final?

 

Phasesaber
http://en.wikipedia.org/wiki/Final_(Java)
http://stackoverflow.com/questions/15655012/how-final-keyword-works
http://www.javamex.com/tutorials/synchronization_final.shtml
http://javapapers.com/core-java/explain-the-final-keyword-in-java/
http://lmgtfy.com/?q=final+keyword+java

 

Skyost I know what final is, just why make everything final? It works fine without it.

 

Phasesaber It works fine but using final is better.

 

I guess so, I usually only use final for config files & things it don't want to be overwritten.

 

Phasesaber I use final for everything that can be.

 

Skyost That's not the best idea. I would only use it if you need to.

 

Phasesaber Not only if you need to but you can use it to make your code clearer :
http://stackoverflow.com/a/6827550
http://stackoverflow.com/a/137946