User

java.lang.Object
- us.forseth11.feudal.user.User

public class User
extends java.lang.Object

This keeps user data.

Author:: Michael Forseth

Constructor Summary

Constructors
Constructor and Description

User(java.lang.String UUID, Configuration config)
Creates a user instance.

Constructors
Constructor and Description
`User(java.lang.String UUID, Configuration config)` Creates a user instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMoney(double money)` Adds money to a user's balance.
`void`	`addPastKingdom(KingdomLog kingdomLog)` Add past kingdom to this user's kingdom log
`void`	`addPastProfession(Profession p)` Add a profession to a user's past professions.
`boolean`	`canHome()`
`boolean`	`canShield()`
`void`	`effectAttributes()` Makes attributes for the user take effect if they are online.
`void`	`effectProfessionData()` Updates the profession data config with this user's new profession.
`void`	`effectReputation(int int1, java.lang.String reason)` Change a user's reputation.
`double`	`getBalance()` Get a user's balance.
`byte`	`getChat()` Check if this user is using kingdom chat, ally chat, or normal chat
`Configuration`	`getConfig()` Get the config for this user
`Kingdom`	`getCurrentKingdom()` Get this user's current kingdom.
`long`	`getFirstJoinTime()` Get the time when a user first joined.
`java.lang.String`	`getKingdomUUID()` Get the player's kingdom uuid.
`long`	`getLastLandMessage()` Get this user's last land message.
`long`	`getLastOnline()` Get when this user was last online.
`java.lang.String`	`getLastTrack()` Gets the uuid of the user which this user previously tracked with a tracker.
`Attributes`	`getLuck()` Get a user's luck
`java.lang.String`	`getName()` Gets user's name
`OnlineTime`	`getOnlineTime()` Gets this users @OnlineTime
`java.util.ArrayList<KingdomLog>`	`getPastKingdoms()` Get this user's kingdom log.
`java.util.ArrayList<Profession>`	`getPastProfessions()` Get a list of a user's past professions.
`org.bukkit.entity.Player`	`getPlayer()` Get the user's player.
`Profession`	`getProfession()` Get a user's profession.
`int`	`getReputation()` Gets reputation
`Attributes`	`getSpeed()` Get a user's speed.
`Attributes`	`getStamina()` Get a user's stamina
`double`	`getStaminaDamage()` Gets this user's stamina damage multiplier.
`Attributes`	`getStrength()` Gets a user's strength.
`int`	`getTotalAtt()` Get all attribute levels added together.
`Attributes`	`getToughness()` Gets a user's toughness.
`java.lang.String`	`getUUID()` Get a user's uuid
`void`	`loadPermissions()`
`void`	`regenStamina()` This is called to regen the damage multiplier effected by stamina.
`void`	`removeMoney(double money)` Removes money from a user's balance.
`void`	`save()` Saves a user.
`void`	`sendOfflineMessage(java.lang.String string)` Sends this user a message which they will get the next time they join.
`void`	`setChat(byte chat)` Sets this user to using kingdom chat or ally chat.
`void`	`setCurrentKingdom(Kingdom k)` Sets a player's current kingdom.
`static void`	`setDefaults(org.bukkit.entity.Player player, Configuration config)` Sets a players's config as default.
`void`	`setHome(boolean b)`
`void`	`setKingdomUUID(java.lang.String uuid)` Sets a player's kingdom uuid.
`void`	`setLastLandMessage(long currentTimeMillis)` Sets this user's last land message.
`void`	`setLastTrack(java.lang.String uuid)` Sets the uuid of the user which this user previously tracked with a tracker.
`void`	`setLuck(Attributes luck)` Set a user's luck
`void`	`setProfession(Profession profession2)` Set a user's profession
`void`	`setShield(int i)`
`void`	`setSpeed(Attributes speed)` Set a user's speed
`void`	`setStamina(Attributes stamina)` Set a user's stamina
`void`	`setStrength(Attributes strength)` Set a user's strength
`void`	`setToughness(Attributes toughness)` Set a user's toughness
`java.lang.String`	`shieldCooldown()`
`void`	`staminaHit()` Decrease damage % accordingly based on stamina level.
`void`	`syncBalance()` Syncs balance with vault.
`void`	`unloadPermissions()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - User
```
public User(java.lang.String UUID,
            Configuration config)
```
    Creates a user instance. This will load a player from a config.
    
    Parameters:
    
    UUID -
    
    config -
- Method Detail
  - syncBalance
```
public void syncBalance()
```
    Syncs balance with vault.
  - addMoney
```
public void addMoney(double money)
```
    Adds money to a user's balance. The money must be greater than 0. This will effect vault if vault is enabled.
    
    Parameters:
    
    money -
  - removeMoney
```
public void removeMoney(double money)
```
    Removes money from a user's balance. The money must be greater than 0. This will effect vault if vault is enabled. Check if player has enough money first by snycing balance and getting the balance.
    
    Parameters:
    
    money -
  - save
```
public void save()
```
    Saves a user.
  - setDefaults
```
public static void setDefaults(org.bukkit.entity.Player player,
                               Configuration config)
```
    Sets a players's config as default. Will not function properly if the config is not empty or new.
    
    Parameters:
    
    player -
    
    config -
  - getProfession
```
public Profession getProfession()
```
    Get a user's profession.
    
    Returns:
  - getStrength
```
public Attributes getStrength()
```
    Gets a user's strength.
    
    Returns:
  - getToughness
```
public Attributes getToughness()
```
    Gets a user's toughness.
    
    Returns:
  - getSpeed
```
public Attributes getSpeed()
```
    Get a user's speed.
    
    Returns:
  - getStamina
```
public Attributes getStamina()
```
    Get a user's stamina
    
    Returns:
  - getLuck
```
public Attributes getLuck()
```
    Get a user's luck
    
    Returns:
  - setProfession
```
public void setProfession(Profession profession2)
```
    Set a user's profession
    
    Parameters:
    
    profession2 -
  - setStrength
```
public void setStrength(Attributes strength)
```
    Set a user's strength
    
    Parameters:
    
    strength -
  - setToughness
```
public void setToughness(Attributes toughness)
```
    Set a user's toughness
    
    Parameters:
    
    toughness -
  - setSpeed
```
public void setSpeed(Attributes speed)
```
    Set a user's speed
    
    Parameters:
    
    speed -
  - setStamina
```
public void setStamina(Attributes stamina)
```
    Set a user's stamina
    
    Parameters:
    
    stamina -
  - setLuck
```
public void setLuck(Attributes luck)
```
    Set a user's luck
    
    Parameters:
    
    luck -
  - getPlayer
```
public org.bukkit.entity.Player getPlayer()
```
    Get the user's player. CAN BE NULL
    
    Returns:
  - getUUID
```
public java.lang.String getUUID()
```
    Get a user's uuid
    
    Returns:
  - getBalance
```
public double getBalance()
```
    Get a user's balance.
    
    Returns:
  - effectAttributes
```
public void effectAttributes()
```
    Makes attributes for the user take effect if they are online. This is called when a user instance is created. This will call effectProfessionData within this method.
  - getPastProfessions
```
public java.util.ArrayList<Profession> getPastProfessions()
```
    Get a list of a user's past professions.
    
    Returns:
  - addPastProfession
```
public void addPastProfession(Profession p)
```
    Add a profession to a user's past professions.
    
    Parameters:
    
    p -
  - effectProfessionData
```
public void effectProfessionData()
```
    Updates the profession data config with this user's new profession.
  - getName
```
public java.lang.String getName()
```
    Gets user's name
    
    Returns:
  - getReputation
```
public int getReputation()
```
    Gets reputation
    
    Returns:
  - getConfig
```
public Configuration getConfig()
```
    Get the config for this user
    
    Returns:
  - getKingdomUUID
```
public java.lang.String getKingdomUUID()
```
    Get the player's kingdom uuid. This SHOULD be empty but not null if they are not in a kingdom.
    
    Returns:
  - setKingdomUUID
```
public void setKingdomUUID(java.lang.String uuid)
```
    Sets a player's kingdom uuid. (What kingdom they are in)
    
    Parameters:
    
    uuid -
  - addPastKingdom
```
public void addPastKingdom(KingdomLog kingdomLog)
```
    Add past kingdom to this user's kingdom log
    
    Parameters:
    
    kingdomLog -
  - getPastKingdoms
```
public java.util.ArrayList<KingdomLog> getPastKingdoms()
```
    Get this user's kingdom log. (Joining and leaving of kingdoms)
    
    Returns:
  - getOnlineTime
```
public OnlineTime getOnlineTime()
```
    Gets this users @OnlineTime
    
    Returns:
  - getLastOnline
```
public long getLastOnline()
```
    Get when this user was last online. Last online is the last time they joined.
    
    Returns:
  - getFirstJoinTime
```
public long getFirstJoinTime()
```
    Get the time when a user first joined.
    
    Returns:
  - effectReputation
```
public void effectReputation(int int1,
                             java.lang.String reason)
```
    Change a user's reputation. int1 is the change.
    
    Parameters:
    
    int1 -
    
    reason -
  - sendOfflineMessage
```
public void sendOfflineMessage(java.lang.String string)
```
    Sends this user a message which they will get the next time they join.
    
    Parameters:
    
    string -
  - getCurrentKingdom
```
public Kingdom getCurrentKingdom()
```
    Get this user's current kingdom. This kingdom is the kingdom which owns the land this user is on. Can be null.
    
    Returns:
  - setCurrentKingdom
```
public void setCurrentKingdom(Kingdom k)
```
    Sets a player's current kingdom. This kingdom is the kingdom which owns the land this user is on.
    
    Parameters:
    
    k -
  - getLastLandMessage
```
public long getLastLandMessage()
```
    Get this user's last land message. The last time they were notified of changing land claims. This is used to avoid spaming the player.
    
    Returns:
  - setLastLandMessage
```
public void setLastLandMessage(long currentTimeMillis)
```
    Sets this user's last land message.
    
    Parameters:
    
    currentTimeMillis -
  - getChat
```
public byte getChat()
```
    Check if this user is using kingdom chat, ally chat, or normal chat
    
    Returns:
  - setChat
```
public void setChat(byte chat)
```
    Sets this user to using kingdom chat or ally chat. Normal = 0 Kingdom = 1 Allies and kingdom = 2
    
    Parameters:
    
    chat -
  - getTotalAtt
```
public int getTotalAtt()
```
    Get all attribute levels added together.
    
    Returns:
  - staminaHit
```
public void staminaHit()
```
    Decrease damage % accordingly based on stamina level. This is called when a player swings their arm and hits their enemy.
  - regenStamina
```
public void regenStamina()
```
    This is called to regen the damage multiplier effected by stamina.
  - getStaminaDamage
```
public double getStaminaDamage()
```
    Gets this user's stamina damage multiplier.
    
    Returns:
  - getLastTrack
```
public java.lang.String getLastTrack()
```
    Gets the uuid of the user which this user previously tracked with a tracker.
    
    Returns:
  - setLastTrack
```
public void setLastTrack(java.lang.String uuid)
```
    Sets the uuid of the user which this user previously tracked with a tracker.
    
    Parameters:
    
    uuid -
  - setShield
```
public void setShield(int i)
```
  - canShield
```
public boolean canShield()
```
  - shieldCooldown
```
public java.lang.String shieldCooldown()
```
  - setHome
```
public void setHome(boolean b)
```
  - canHome
```
public boolean canHome()
```
  - unloadPermissions
```
public void unloadPermissions()
```
  - loadPermissions
```
public void loadPermissions()
```

Class User

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

User

Method Detail

syncBalance

addMoney

removeMoney

save

setDefaults

getProfession

getStrength

getToughness

getSpeed

getStamina

getLuck

setProfession

setStrength

setToughness

setSpeed

setStamina

setLuck

getPlayer

getUUID

getBalance

effectAttributes

getPastProfessions

addPastProfession

effectProfessionData

getName

getReputation

getConfig

getKingdomUUID

setKingdomUUID

addPastKingdom

getPastKingdoms

getOnlineTime

getLastOnline

getFirstJoinTime

effectReputation

sendOfflineMessage

getCurrentKingdom

setCurrentKingdom

getLastLandMessage

setLastLandMessage

getChat

setChat

getTotalAtt

staminaHit

regenStamina

getStaminaDamage

getLastTrack

setLastTrack

setShield

canShield

shieldCooldown

setHome

canHome

unloadPermissions

loadPermissions