AlttdGriefPrevention/src/me/ryanhamshire/GriefPrevention/PlayerData.java

/*
    GriefPrevention Server Plugin for Minecraft
    Copyright (C) 2011 Ryan Hamshire

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package me.ryanhamshire.GriefPrevention;
import java.net.InetAddress;
import java.util.Calendar;
import java.util.Date;
import java.util.UUID;
import java.util.Vector;

import me.ryanhamshire.GriefPrevention.Claim;
import me.ryanhamshire.GriefPrevention.GriefPrevention;
import me.ryanhamshire.GriefPrevention.ShovelMode;
import me.ryanhamshire.GriefPrevention.SiegeData;
import me.ryanhamshire.GriefPrevention.Visualization;

import org.bukkit.Location;

//holds all of GriefPrevention's player-tied data
public class PlayerData 
{
	//the player's ID
	public UUID playerID;
	
	//the player's claims
	public Vector<Claim> claims = new Vector<Claim>();
	
	//how many claim blocks the player has earned via play time
	public int accruedClaimBlocks = GriefPrevention.instance.config_claims_initialBlocks;
	
	//where this player was the last time we checked on him for earning claim blocks
	public Location lastAfkCheckLocation = null;
	
	//how many claim blocks the player has been gifted by admins, or purchased via economy integration 
	public int bonusClaimBlocks = 0;
	
	//what "mode" the shovel is in determines what it will do when it's used
	public ShovelMode shovelMode = ShovelMode.Basic;
	
	//radius for restore nature fill mode
	int fillRadius = 0;
	
	//last place the player used the shovel, useful in creating and resizing claims, 
	//because the player must use the shovel twice in those instances
	public Location lastShovelLocation = null;	
	
	//the claim this player is currently resizing
	public Claim claimResizing = null;
	
	//the claim this player is currently subdividing
	public Claim claimSubdividing = null;
	
	//the timestamp for the last time the player used /trapped
	public Date lastTrappedUsage;
	
	//whether or not the player has a pending /trapped rescue
	public boolean pendingTrapped = false;
	
	//last place the player damaged a chest
	public Location lastChestDamageLocation = null;
	
	//number of blocks placed outside claims before next warning
	int unclaimedBlockPlacementsUntilWarning = 1;
	
	//timestamp of last death, for use in preventing death message spam
	long lastDeathTimeStamp = 0;
	
	//spam
	public Date lastLogin;							//when the player last logged into the server
	public String lastMessage = "";					//the player's last chat message, or slash command complete with parameters 
	public Date lastMessageTimestamp = new Date();  //last time the player sent a chat message or used a monitored slash command
	public int spamCount = 0;						//number of consecutive "spams"
	public boolean spamWarned = false;				//whether the player recently received a warning
	
	//visualization
	public Visualization currentVisualization = null;
	
	//anti-camping pvp protection
	public boolean pvpImmune = false;
	public long lastSpawn = 0;
	
	//ignore claims mode
	public boolean ignoreClaims = false;
	
	//the last claim this player was in, that we know of
	public Claim lastClaim = null;
	
	//location of the last successfully-broken block, used in a performance optimization
	Location lastSuccessfulBreak = null;
	
	//siege
	public SiegeData siegeData = null;
	
	//pvp
	public long lastPvpTimestamp = 0;
	public String lastPvpPlayer = "";
	
	//safety confirmation for deleting multi-subdivision claims
	public boolean warnedAboutMajorDeletion = false;

	public InetAddress ipAddress;
	
	PlayerData()
	{
		//default last login date value to 5 minutes ago to ensure a brand new player can log in
		//see login cooldown feature, PlayerEventHandler.onPlayerLogin()
		//if the player successfully logs in, this value will be overwritten with the current date and time 
		Calendar fiveMinutesBack = Calendar.getInstance();
		fiveMinutesBack.add(Calendar.MINUTE, -5);
		this.lastLogin = fiveMinutesBack.getTime();		
		
		//default last trapped usage to 5 hours ago, so the command is available right away
		fiveMinutesBack.add(Calendar.HOUR, -5);
		this.lastTrappedUsage = fiveMinutesBack.getTime();
	}
	
	//whether or not this player is "in" pvp combat
	public boolean inPvpCombat()
	{
		if(this.lastPvpTimestamp == 0) return false;
		
		long now = Calendar.getInstance().getTimeInMillis();
		
		long elapsed = now - this.lastPvpTimestamp;
		
		if(elapsed > GriefPrevention.instance.config_pvp_combatTimeoutSeconds * 1000) //X seconds
		{
			this.lastPvpTimestamp = 0;
			return false;
		}
		
		return true;
	}
	
	//the number of claim blocks a player has available for claiming land
	public int getRemainingClaimBlocks()
	{
		int remainingBlocks = this.accruedClaimBlocks + this.bonusClaimBlocks;
		for(int i = 0; i < this.claims.size(); i++)
		{
			Claim claim = this.claims.get(i);
			remainingBlocks -= claim.getArea();
		}
		
		//add any blocks this player might have based on group membership (permissions)
		remainingBlocks += GriefPrevention.instance.dataStore.getGroupBonusBlocks(this.playerID);
		
		return remainingBlocks;
	}
}