Add custom methods to Player

Hi, I'm making a plugin where there is two teams.
In the game, there is some actions only the red players can do, so I was searching to make custom methods like this :

Code:java

public class CustomPlayer {
 
private Player player;
 
public CustomPlayer(final Player player)
{
this.player = player;
}
 
private String team;
 
public Player getPlayer()
{
return player;
}
 
public void setTeam(String team)
{
this.team = team;
}
 
public String getTeam()
{
return team;
}
}
 

I add the player in the red team when he interacts with a sign :

Code:java

CustomPlayer customPlayer = new CustomPlayer();
customPlayer.setTeam("red");

And there is no error but... when I have to ckeck if the player is in the good team I do :

Code:java

CustomPlayer customPlayer = new Customplayer(p);
 
if(customplayer.getTeam() == "red")
{
// Doing some stuff
}

And I'm getting a NullPointerException.

Thank you for helping.

 

You team variable isnt set use this as your constructor:

Code:

 public CustomPlayer(final Player player)
    {
        this.player = player;
        this.team = null;
    }

And I would replace 'private Player player;' with 'private final Player player;'

 

Ok, so I changed "private Player player" to "private final Player player" and add my team variable in the constructor.
I add the player to a team when he hits a sign with :

Code:java

CustomPlayer customPlayer = new CustomPlayer();
customPlayer.setTeam("red");

And when he hurts the check sign i'm getting a NullPointerException :

Code:java

CustomPlayer customPlayer = new CustomPlayer(p);
customPlayer.getPlayer().sendMessage(customPlayer.getTeam());

 

You are creating two separate instances of CustomPlayer and expecting them to be the same (and not passing a player to your first instance?). How you are going about this is a bit weird to me (although I don't know what your end goal is), but you need to store the CustomPlayer in an array/list and get this instance (when needed) rather than creating a new one.

 

Ok, I'm gonna try.

If I store my CustomPlayers in an ArrayList<CustomPlayer>, how can I get my Customlayer when I want to do customPlayer.getTeam() ?

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

 

Code:

if(customplayer.getTeam() == "red")

Shouldn't that be:

Code:

if(customplayer.getTeam().equals("red"))

as you are comparing Strings?

 

Like iKanak said, i'm using two differents instances.

 

colozz please, never store the player object anywhere. You dont need the whole object you probably only need partial information and if you ever need to get the location then you could just add a method that can do that through bukkit API.

Modifications to your class:

private String playerName = "Player";

// constructor
public CustomPlayer(String playerName) {
this.playerName = playerName;
}

public Player getPlayer() {
return Bukkit.getPlayerExact(this.getName());
}

public String getName() {
return this.playerName;
}

getPlayer("Player").getLocation();

could also be linked to your class as

public Location getLocation() {
return this.getPlayer(this.getName()).getLocation();
}

Also checkout my post at http://forums.bukkit.org/threads/ghost-players-not-working.153297/#post-1714104 this might help you a bit if you ask yourself how you could actually add some custom properties to a generic object.

 

Ok I try to modify my code this way.

Ok so I've modified my code but I don't understand how to use my customPlayer.setTeam() and how to use my customPlayer.getTeam, I know I tried to use

Code:java

CustomPlayer customPlayer = new CustomPlayer(p.getName);

but it's again another instance.

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

 

for getTeam i would create another class and create a hashmap to store the team assignment.

Something like i posted in another post or easy way ...

Map<String, TeamAssignment> teamAssignment = new HashMap<String, TeamAssignment>();

TeamAssignment is abstract class that will be extended by TeamRed or TeamBlue or whatever.

Make a method that can getTeam() for the custom player and access the teamAssignment hashmap.

Of course you need to addTeam first ... something like teamAssignment.put("Player", new TeamRed());

..

 

I didn't succeed because I never used hashmaps and I'm not very good in english so I'm gonna create two ArrayList<String> in the main class and add the players name inner.
thank you for your help :/

 

colozz Tell me exactly what you need and i might be able to give you a complete class package =)

What data do you need from the Player in CustomPlayer object?
Should the CustomPlayer object hold its data?

 

Did you ever think about mamkingn a Team class that contains a list of players? I think, this is the more straightforwarded way.

 

Ok so, I'm creating a a game where there is two teams. They can join the game by typing /join. Here what I done works perfectly. But I searched to known in which team a player is when he enters a specific area. If he is red, he is teleported and if he is blue, nothing happends. So I created in the first version of my plugin two ArrayList<String> and when a player join a team (by typing /join) I did :

Code:java

teamBlue.add(p.getName());

But when I have to check if the player is in the good team I did :

Code:java

if(teamRed.contains(p.getName()) {
// teleportation
}

But the problems began, with the update of my plugin, each player have more properties and if later I have to make more teams, my code will be unreadable and non-extensible.

So I just want to create a class where I make getters and setters for the players like setTeam() and getTeam().
So in the code I will write :

Code:java

int r = (int) (Math.random * 10000);
if(r <= 5000) {
p.setTeam("Blue");
}

And :

Code:java

if(p.isBlue()) {
// teleportation
}

Thank you for helping

 

Okay, so then I would suggest one of those two different Methods: Either use Metadata or a PlayerProperties object.

There are good tutorials for Metadata. You can set Metadata for many things like players, locations, blocks etc. It is as easy like this:

Code:java

    public static void setMetadata(Metadatable obj, String key, Object value) {
        obj.setMetadata(key,new FixedMetadataValue(CaptureTheFlag.getPlugin(), value));
    }
 
    public static MetadataValue getMetadata(Metadatable obj, String key){
        for(MetadataValue value : obj.getMetadata(key)){
            if(value.getOwningPlugin().getDescription().getName().equals(CaptureTheFlag.getPlugin().getDescription().getName())){
                return value;
            }
        }
        return null;
    }

Method two is a PlayerProperties object similar to what you did. Instead of creating a new one every time and save the Player inside the object do something like this:

Code:java

private HashMap<String, PlayerProperties> properties = new HashMap<String, PlayerProperties>;
 
public void create(Player player) {
    PlayerProperties p = new PlayerProperties();
    p.setTeam("red");
    properties.put(player.getName(), p);
}
 
public void check(Player player) {
    PlayerProperties p = properties.get(player.getName());
    if(p.getTeam().equals("red")) {
 
    }
}

 

colozz ok so we have:

• PlayerData
• TeamAssignment
• Rules per Team

I will try to create something for you to use.

 

Ok, thank you, I'm gonna try to make something too

 

AmShaegar afaik Metadata is not persistent. Has this changed?

 

No it hasn't.

 

AmShaegar, where did you found the object PlayerProperties ?

 

colozz here is something that should help you.

I left out the Rule system as i think you can do that now on your own =)

Code:java

 
public interface CustomPlayer {
 
    public Player getPlayer();
    public String getName();
    public String getDisplayName();
    public Location getLocation();
 
}
 

Code:java

 
public class TeamPlayer implements CustomPlayer {
 
    private String playerName;
    private Team membership;
 
    public TeamPlayer(Player player) {
        this(player.getName(), new TeamNone());
    }
 
    public TeamPlayer(Player player, Team membership) {
        this(player.getName(), membership);
    }
 
    public TeamPlayer(String playerName) {
        this(playerName, new TeamNone());
    }
 
    public TeamPlayer(String playerName, Team membership) {
        this.playerName = playerName;
        this.membership = membership;
    }
 
    /**
        Get the Player's name
        
        @return String The player's name
    **/
    public String getName() {
        return this.playerName;
    }
 
    /**
        Get the Player's current Display-Name
        
        @return String The Player's currently assigned display name
    **/
    public String getDisplayName() {
        return this.getPlayer().getDisplayName();
    }
 
    /**
        Checks the Player's online-status
        
        @return boolean true if online otherwise false
    **/
    public boolean isOnline() {
        return Bukkit.getOfflinePlayer(this.getName()).isOnline();
    }
 
    /**
        Get the Player object
        
        @return Player the player instance
    **/
    public Player getPlayer() {            
        return Bukkit.getPlayerExact(this.getName());
    }
 
    /**
        Get the current player's location
        
        @return Location the current player's location
    **/
    public Location getLocation() {            
        return this.getPlayer().getLocation();
    }
 
    /**
        Retrive the current Team Membership associated with the current TeamPlayer
        
        @return Team Membership
    **/
    public Team getMembership()  {
        return this.membership;
    }
 
    public String getTeamName() {
        return this.getMembership().getName();
    }
 
    public void setMembership(Team membership) {
        this.membership = membership;
    }
 
}
 

Code:java

 
public enum TeamAssignment {
    NONE("Unassigned"),
    BLUE("Blue"),
    RED("Red");
 
    private String name;
 
    private TeamAssignment(String name) {
        this.name = name;
    }
 
    public String getName() {
        return this.name;
    }
}
 

Code:java

 
public abstract class Team {
 
    private TeamAssignment teamAssignment = TeamAssignment.NONE;
 
    public Team(TeamAssignment teamAssignment) {
        this.teamAssignment = teamAssignment
    }
 
    public TeamAssignment getAssignment() {
        return this.teamAssignment;
    }
 
    /**
        Get the team's name
        
        @return String Returns membership assignment as string
    **/
    public String getName() {
        return this.getAssignment().getName();
    }
}
 

Code:java

 
public class TeamNone extends Team {
 
    public TeamNone() {
        super(TeamAssignment.NONE);
    }
 
}
 

Code:java

 
public class TeamBlue extends Team {
 
    public TeamBlue() {
        super(TeamAssignment.BLUE);
    }
 
}
 

Code:java

 
public class TeamRed extends Team {
 
    public TeamRed() {
        super(TeamAssignment.RED);
    }
 
}
 

Code:java

 
public class TeamPlayerManager {
 
    private Map<String, TeamPlayer> teamPlayers = new HashMap<String, TeamPlayer>();
 
    public boolean isTeamPlayer(Player player) {
        return this.isTeamPlayer(player.getName());
    }
 
    public boolean isTeamPlayer(String playerName) {
        // debug
        System.out.println("isTeamPlayer: " + playerName + ", result: " + (this.teamPlayers.get(playerName.toLowerCase()) == null));
 
        return (!(this.teamPlayers.get(playerName.toLowerCase()) == null));
    }
 
    public void addTeamPlayer(Player player) {
        this.addTeamPlayer(player, new TeamNone());
    }
 
    public void addTeamPlayer(String playerName) {
        this.addTeamPlayer(playerName, new TeamNone());
    }
 
    public void addTeamPlayer(Player player, Team membership) {
        this.addTeamPlayer(player.getName(), membership);
    }
 
    public void addTeamPlayer(String playerName, Team membership) {
        if (this.isTeamPlayer(playerName))
            return;
 
        this.teamPlayers.put(playerName.toLowerCase(), new TeamPlayer(playerName, membership));
    }
 
    public TeamPlayer getTeamPlayer(Player player) {
        return this.getTeamPlayer(player.getName());
    }
 
    public TeamPlayer getTeamPlayer(String playerName) {
        return this.teamPlayers.get(playerName.toLowerCase());
    }
 
    public void removeMembership(Player player) {
        this.removeMembership(player.getName());
    }
 
    public void removeMembership(String playerName) {
        if (!this.isTeamPlayer(playerName))
            return;
 
        this.setMembership(playerName, new TeamNone());
    }
 
    public void setMembership(Player player, Team membership) {
        this.setMembership(player.getName(), membership);
    }
 
    public void setMembership(String playerName, Team membership) {
        if (!this.isTeamPlayer(playerName)) {
            this.addTeamPlayer(playerName, membership);
            return;
        }
 
        this.getTeamPlayer(playerName).setMembership(membership);
    }
 
    public Team getMembership(Player player) {
        return this.getMembership(player.getName().toLowerCase());
    }
 
    public Team getMembership(String playerName) {
        if (!this.isTeamPlayer(playerName))
            return new TeamNone();
 
        return this.teamPlayers.get(playerName.toLowerCase()).getMembership();
    }
 
    public String getTeamName(Player player) {
        return this.getTeamName(player.getName());
    }
 
    public String getTeamName(String playerName) {
        return this.getMembership(playerName).getName();
    }
 
    public TeamAssignment getTeamAssignment(Player player) {
        return this.getTeamAssignment(player.getName().toLowerCase());
    }
 
    public TeamAssignment getTeamAssignment(String playerName) {
        return this.getMembership(playerName).getAssignment();
    }
}
 

Code:java

 
// this goes to your head section of your plugin
private TeamPlayerManager teamPlayerManager;
 
// To get access to your TeamManager init it in your onEnable
this.teamPlayerManager = new TeamPlayerManager();
 
// create a static method to get your manager from your plugin directly if you need the same instance
// in all classes OR pass it to the class
 
...registerEvents(new PlayerListener(this.teamPlayerManager()));
...getCommand("yourcommand").setExecutor(new YourCommand(this.teamPlayerManager));
 

After that you can use it as you need.

Hope that works as intended. I dont have a compiler here so i cant check. If there is a problem just tell me =)

 

Thank you for your help and thank you for the JavaDoc =)

But there is some errors in TeamPlayerManager :

- In the method isMember(String playerName), change :

Code:java

return this.playerMemberShips.containsKey(playerName.toLowerCase());

By :

Code:java

return this.teamPlayers.containsKey(playerName.toLowerCase());

- Change the method :

Code:java

setMembership(Player player, Team membership)

To :

Code:java

setMembership(Player player, TeamAssignment membership)

And do the same for setMembership(String playerName, Team membership)

- You forget the "return" is the method getMembership(Player player)

- Change the method :

Code:java

public Team getMembership(String playerName)

To :

Code:java

public TeamAssignment getMembership(String playerName)

And do the same for getMemberShip(Player player)

- In the method setmembership(String playername, TeamAssignment membership), there is :

Code:java

this.addTeamPlayer(playerName, membership)

But the method addTeamPlayer(String playerName) has only one argument

- In the method


And in TeamPlayer :

- In the method TeamPlayer(String playerName, Team membership), "player" cannot be resolvedso there is errors on :

Code:java

this.playerName = player.getName();
this.playerDisplayName = player.getDisplayName();
this.membership = membership;

- Change :

Code:java

private Team membership;

To :

Code:java

private TeamAssignment membership;

- Change the method :

Code:java

public Team getMembership()

To :

Code:java

public teamAssignment getMembership()

- Change the method public Player getPlayer()

Code:java

return Bukkit.getPlayerExact(this.getPlayerName());

To :

Code:java

return Bukkit.getPlayerExact(this.getName());

And finally in the main class, what do you mean for "PlayerListener" ?
It is my main Listener or have I to create the class PlayerListener ?

I try to correct other little errors and I will tell you them.

 

Did anyone request those properties like the team to be persistent?

I did not find it. That would be the class you have to create instead of your CustomPlayer that implements Player.

 

colozz oh thanks i will change my post. Glad you could fix it by yourself =) I had this done yesturday and was going to seperate team and player object in teammanager and thought "i dont have to do that". Seems i missed correcting that =)

PlayerListener was an example of how you could use the manager class to demonstrate that you actually would have to pass the Manager to the class to use it internally.

Also this is a decision you can make on your own. Weither you init it in your main java class or only in one. Depends if you need to use the same instance in different places.

 

AmShaegar Ok thanks

lycano I didn't understood how to use the Manager internally but I think I will find how to use what you done, I'm gonna see this afternoon if the code works, thank you =)

A little error, in your class TeamBlue, you wrote

Code:java

super(TeamAssignment.RED);

In your TeamPlayerManager, in the method addTeamPlayer you made :

Code:java

playerName = playerName.toLowerCase();
if (this.isTeamPlayer(playerName))
return;
 
this.teamPlayers.put(playerName, new TeamPlayer(playerName, membership));

But the constructor TeamPlayer is TeamPlayer(String playerName, String playerDisplayName, Team membership)
So we have to write :

Code:java

this(playerName, Bukkit.getPlayerExact(playerName).getDisplayName(), new TeamNone());

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

 

colozz i edited my post. Check it for updates =) Also you where on the right track. There was no TeamAssignment return and because i used a mixed up version of an older state you corrected it as good as you could. Nice work!

But i designed it to always return Team object as you can get the assignemt from there.

Store TeamPlayers -> Contains Team -> Team can be assigned to be either None, Blue, Red

To check for Team assignment you can use a switch now as i implemented additional methods to get the assignment from the team object.

Code:

TeamAssignment ta = this.teamPlayerManager.getTeamAssignment("Player");
switch (ta) {
    case NONE:
        // do stuff
        break;
    case RED:
        // do stuff for red team
        break;
    case BLUE:
        // do stuff for blue team
        break;
}

Hint: This can be used for your rules system. Just repeat the abstraction of Team for Rules and implement it in Team abstracted class.

Some more examples for the RuleSystem i would use:

Code:java

 
public interface Rule {
 
    public String getName();
    public String getDescription();
    public boolean isActive();
    public void enable();
    public void disable();
    public void apply();
 
}
 

Code:java

 
public abstract class TeamRule implements Rule {
 
    private String ruleName;
    private String ruleDescription;
    private boolean ruleActiveStatus;
 
    public TeamRule(String name) {
        this(name, null, false);
    }
 
    public TeamRule(String name, String desciprtion) {
        this(name, description, false);
    }
 
    public TeamRule(String name, String description, boolean active) {
        this.ruleName = name;
        this.ruleDescription = description;
        this.ruleActiveStatus = active;
    }
 
    public boolean isActive() {
        return this.ruleActiveStatus;
    }
 
    public void enable() {
        this.ruleActiveStatus = true;
    }
 
    public void disable() {
        this.ruleActiveStatus = false;
    }
 
    public abstract void apply();
 
}
 

Code:java

 
public class FriendlyFireRule extends TeamRule {
 
    public FriendlyFireRule() {
        super("Friendly Fire", "Allows/Disallows friendly fire", false);
    }
 
    public void apply() {
        // do stuff
    }
}
 

The apply() method can be used to implement your logic but this would require you to pass the TeamPlayer object as you might need to set stuff for a player. Or you implement the logic elsewhere and remove execute and use the structure only for message output and stuff.

colozz i removed displayName from TeamPlayer. Its now fetched via getPlayerExact().

Also i fixed some bugs

• where a playerName would always be lowercase
• isOnline does return null when the player is not online.
• removed unneeded toLowerCase() calls

Some methods will return null like getLocation() or getDisplayName() indicating that the player is not online.

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

 

Ok, I'm gonna correct my code, thanks.

Ok, so I have a last question to use this code perfectly, how should I implement another property like a class system, with getClass() and setClass() ?

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

 

If it is a player property just add this to the interface and then to TeamPlayer as method. If its something team specific add this to Team abstract class and if it should be teamRed specific override it there so it does something else.

 

Ok thank you very much for helping =)

 

You're welcome!