[Tutorial] Sign Changing and Interacting

This is my first tutorial, so just ignore my 'noobness'. And I've been seeing people getting issues with sign changing and interacting with a sign. Remember this is all an example, don't use what I'm doing exactly. Also, really pay attention to the notes to know how to stop people from exploiting bugs/glitches Sign Changing and Interacting is probably one of my favorite things within Bukkit to be honest since it's so broad, you can do the following with Interacting:

*READ THIS* IGNORE ALL NOTES SAYING CAPITALIZATION MATTERS, I MADE AN ERROR WHILE TESTING AND I THOUGHT IT WAS RELATED TO CAPITALIZATION*

• Having the player perform a command
• Creating a player inventory and opening it
• Even killing the player
• etc.

You obviously know what Sign Changing does just by the name of it, the name of the events are:
PlayerInteractEvent & SignChangeEvent. I'm first going to show you how to do the SignChangeEvent, I have a GitHub for all of this at the bottom, and it has somewhat decent documentation, feel free to do a PR. If you'd rather read the GitHub than this, I understand, because it'll be harder for me to go line by line

SignChangeEvent:

Remember to put the @EventHandler annotation.

Code:java

 @EventHandler
public void onSignChange(SignChangeEvent e) {
Player p = e.getPlayer();

That'll register the event and it will register the annotation, make sure to import the right EventHandler I believe there is one for Google.

Next you will want to get the first line, defined as line 0, this will check the line text, so if you want to check if it is equal to [KitMe] you'd do this:

Code:java

if(e.getLine(0).equalsIgnoreCase("[KitMe]")) { //Capitalization matters for this.

That's an If statement, obviously, so now I would recommend checking if the player has permission to prevent exploiting bugs/glitches, so next, put something like this to prevent that, and if the player doesn't have permission, it won't do anything:

Code:java

if(p.hasPermission("kitme.admin.signmake")) { //If the player has that permission, it'll set the line, else, it won't, that will be good so people can't exploit a glitch, although,
//a colored signs plugin ex: Essentials can conflict if you use it, and give the permission to reg players, I suggest not to.

Now, if the player that placed the sign has permission, the sign will change, if he doesn't, then that sucks for the player, setting the line is a bit different from getting the line, now this is how you'd stop people from exploiting bugs:

Code:java

e.setLine(0, ChatColor.BLACK + "[" + ChatColor.DARK_RED + "KitMe" + ChatColor.BLACK + "]"); //Capitalization matters for this too.

Okay, that's it for Sign Changing, and if you're wondering how people could exploit bugs, if you didn't add a permission to changing the sign, they could exploit it and get a bunch of items or what ever you want the sign to do. It can also be an issue when it comes to Player Interacting if the player has essentials sign color they could just add the color to the sign manually and exploit it, although, they'd need permission to what ever the sign is suppose to do. Here's the full Event for SignChangeEvent

Code:java

 @EventHandler
public void onSignChange(SignChangeEvent e) {
Player p = e.getPlayer();
if(e.getLine(0).equalsIgnoreCase("[KitMe]")) { //Capitalization matters for this.
if(p.hasPermission("kitme.admin.signmake")) { //If the player has that permission, it'll set the line, else, it won't, that will be good so people can't exploit a glitch, although,
//a colored signs plugin ex: Essentials can conflict if you use it, and give the permission to reg players, I suggest not to.
e.setLine(0, ChatColor.BLACK + "[" + ChatColor.DARK_RED + "KitMe" + ChatColor.BLACK + "]"); //Capitalization matters for this too.
}
}
}

PlayerInteractEvent:

Remember to put the EventHandler annotation again

Code:java

 @EventHandler
public void SignClick(PlayerInteractEvent e) {
Player p = e.getPlayer();

Next you want to check how the player is interacting, it can be:

• LEFT_CLICK_BLOCK
• LEFT_CLICK_AIR
• PHYSICAL
• RIGHT_CLICK_BLOCK
• RIGHT_CLICK_AIR

If we're interacting with a sign it can be LEFT_CLICK_BLOCK or RIGHT_CLICK_BLOCK since you can do both on a sign, and a sign is a block. I'll use RIGHT_CLICK_BLOCK as an example though, it's not hard to change, it won't be anything different except the Action type.

So now to get the Action:

Code:java

if (e.getAction() == Action.RIGHT_CLICK_BLOCK){ //Checks if person is right clicking on a block

Now that you checked how the player is making the action, now you need to check what he's interacting with exactly, what block he's interacting with and getting it's state:

Code:java

if (e.getClickedBlock().getState() instanceof Sign) { //This checks if the player is right clicking on the sign and it'll do all the code below if it is a sign.
Sign sign = (Sign) e.getClickedBlock().getState();

Now you got to check the first line of the sign, line 0, now, you'd use getLine(), but whatever you used for setLine on the SignChangeEvent, you use for this getLine, so I'd do this:

Code:java

if(sign.getLine(0).equalsIgnoreCase(ChatColor.BLACK + "[" + ChatColor.DARK_RED + "KitMe" + ChatColor.BLACK + "]") && p.getGameMode() == GameMode.SURVIVAL) { //Capitalization matters for this too.

You don't need to check if the player is in GMS but I do, because why would someone need a kit in GMC.

Now, I'm going to check the signs 2nd line, getLine(1), since this is a kit plugin sign example,

Code:java

if(sign.getLine(1).equalsIgnoreCase("Diamond")) { //Capitalization matters for this too.

So if it does contain both it'll look like

[KitMe]
Diamond

If it does contain 'Diamond', it will run this command:

Code:java

p.performCommand("kitme diamond"); //This will run all the code under the command 'kitme diamond' besides the updating of the inventory, so you should add that.
p.updateInventory();

Now you're done

This is the event for the Player Interact Event

Code:java

@EventHandler
public void SignClick(PlayerInteractEvent e) {
Player p = e.getPlayer();
if (e.getAction() == Action.RIGHT_CLICK_BLOCK){ //Checks if person is right clicking on a block
if (e.getClickedBlock().getState() instanceof Sign) { //This checks if the player is right clicking on the sign and it'll do all the code below if it is a sign.
Sign sign = (Sign) e.getClickedBlock().getState();
if(sign.getLine(0).equalsIgnoreCase(ChatColor.BLACK + "[" + ChatColor.DARK_RED + "KitMe" + ChatColor.BLACK + "]") && p.getGameMode() == GameMode.SURVIVAL) { //Capitalization matters for this too.
if(sign.getLine(1).equalsIgnoreCase("Diamond")) { //Capitalization matters for this too.
p.performCommand("kitme diamond"); //This will run all the code under the command 'kitme diamond' besides the updating of the inventory, so you should add that.
p.updateInventory();
}
}
}
}
}

Here's the main class too:

Code:java

package org.me.horrgs.signs;
 
import org.bukkit.plugin.java.JavaPlugin;
 
import java.util.logging.Logger;
 
/**
* Created with IntelliJ IDEA.
* User: Matt
* Date: 12/7/13
* Time: 3:14 PM
* To change this template use File | Settings | File Templates.
*/
public final class Main extends JavaPlugin {
 
    public final Logger logger = Logger.getLogger("Minecraft");
    public static Main plugin;
 
    @Override
    public void onEnable() {
        //Enable listener
        getServer().getPluginManager().registerEvents(new SignsEvent(), this);
        getCommand("kitme").setExecutor(new Commands());
    }
 
    @Override
    public void onDisable() {
    }
 
 
}

The full Event class can be found here
The command being ran can be found here
The main class can be found here
The full GitHub can be found here


Thanks for reading, I hope to do more advanced tutorials in the future

Reserved.

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

 

Well that actually checks if it is equal to "[KitMe]" it, not contains it. Also, it says it's case sensitive in the comment but it's not... I'm guessing you meant to put .contains(...) there instead?

 

Ahhh thanks, I didn't notice that, and I shall change that now, and I thought it was case-sensitive? Must've not put in my plugin.... and no, I didn't mean to put contains actually

 

You should probably store the BlockState in a variable when you're checking for it.

Code:

BlockState state = block.getState();

if (state instanceof Sign) { 
  Sign sign = (Sign) state

}

 

Fixed, thanks for that

 

No, .equalsIgnoreCase() isn't case sensitive.

And macguy8, no, you should not do that. You should check if the Material is a sign.
https://forums.bukkit.org/threads/signs-material-sign.148830/#post-1682338

 

Will fix, forgot to, the only reason I thought that was I made a plugin with the sign and it didn't work when we just did all lower cases.

 

I was commenting on the fact .getState() generates a new object each time, therefor it'd be better to store it. As well as yes, it might, the fact that on other materials with a block state, it'd be easier to see how to check that state from my example. Also, what if minecraft were to add a different type of sign or such besides wall sign and sign post? Then your method would break, and mine would still continue to operate correctly.

 

Not sure exactly what you're saying, but this works on all types of Signs, and you can easily change if so.

 

I know, but the other way is future proof, even though it may only be 1 additional line of code.

 

In the event of more signs, I will update this, but it doesn't seem they'll add new signs or more, since what else can you add for signs.

 

you forgot to register the event in the onEnable section of your code like this:

Code:java

Bukkit.getServer().getPluginManager().registerEvents(this, this);

 

It's in the onEnable method of the GitHub here

 

ok i would just put in here on the fourm for the people who dint read the GitHub

 

k, will add now ;o