Package io.github.thebusybiscuit.slimefun4.api.player

Class PlayerProfile

java.lang.Object

io.github.thebusybiscuit.slimefun4.api.player.PlayerProfile

public final class PlayerProfile
extends Object

A class that can store a Player's Research progress for caching purposes. It also holds the backpacks of a Player.

Author:

TheBusyBiscuit

See Also:

Research, PlayerBackpack

Method Summary

Modifier and Type	Method	Description
PlayerBackpack	createBackpack(int size)
static Optional<PlayerProfile>	find(OfflinePlayer p)
static PlayerProfile	fromUUID(UUID uuid)	This is now deprecated, use fromUUID(UUID, Consumer) instead
static boolean	fromUUID(UUID uuid, Consumer<PlayerProfile> callback)
static PlayerProfile	get(OfflinePlayer p)	This is now deprecated, use get(OfflinePlayer, Consumer) instead
static boolean	get(OfflinePlayer p, Consumer<PlayerProfile> callback)	Get the PlayerProfile for a player asynchronously.
HashedArmorpiece[]	getArmor()
PlayerBackpack	getBackpack(int id)
static PlayerBackpack	getBackpack(ItemStack item)
io.github.thebusybiscuit.cscorelib2.config.Config	getConfig()
GuideHistory	getGuideHistory()
Player	getPlayer()
Set<Research>	getResearches()	This Method will return all Researches that this Player has unlocked
String	getTitle()
UUID	getUUID()
boolean	hasUnlocked(Research research)	This method returns whether the Player has unlocked the given Research
boolean	isDirty()	This method returns whether the Profile has unsaved changes
static boolean	isLoaded(UUID uuid)
boolean	isMarkedForDeletion()	This method returns whether the Player has logged off.
static Iterator<PlayerProfile>	iterator()
void	markDirty()	Call this method if this Profile has unsaved changes.
void	markForDeletion()	Call this method if the Player has left.
void	save()	This method will save the Player's Researches and Backpacks to the hard drive
void	sendStats(CommandSender sender)
void	setResearched(Research research, boolean unlock)	This method sets the Player's "researched" status for this Research.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getArmor

public HashedArmorpiece[] getArmor()

getConfig

public io.github.thebusybiscuit.cscorelib2.config.Config getConfig()

getUUID

public UUID getUUID()

isMarkedForDeletion

public boolean isMarkedForDeletion()

This method returns whether the Player has logged off. If this is true, then the Profile can be removed from RAM.

Returns:

Whether the Profile is marked for deletion

isDirty

public boolean isDirty()

This method returns whether the Profile has unsaved changes

Returns:

Whether there are unsaved changes

save

public void save()

This method will save the Player's Researches and Backpacks to the hard drive

setResearched

public void setResearched(Research research,
                          boolean unlock)

This method sets the Player's "researched" status for this Research. Use the boolean to unlock or lock the Research

Parameters:

research - The Research that should be unlocked or locked

unlock - Whether the Research should be unlocked or locked

hasUnlocked

public boolean hasUnlocked(Research research)

This method returns whether the Player has unlocked the given Research

Parameters:

research - The Research that is being queried

Returns:

Whether this Research has been unlocked

getResearches

public Set<Research> getResearches()

This Method will return all Researches that this Player has unlocked

Returns:

A Hashset<Research> of all Researches this Player has unlocked

markForDeletion

public void markForDeletion()

Call this method if the Player has left. The profile can then be removed from RAM.

markDirty

public void markDirty()

Call this method if this Profile has unsaved changes.

createBackpack

public PlayerBackpack createBackpack(int size)

getBackpack

public PlayerBackpack getBackpack(int id)

getTitle

public String getTitle()

sendStats

public void sendStats(CommandSender sender)

getPlayer

public Player getPlayer()

getGuideHistory

public GuideHistory getGuideHistory()

fromUUID

public static PlayerProfile fromUUID(UUID uuid)

This is now deprecated, use fromUUID(UUID, Consumer) instead

Parameters:

uuid - The UUID of the profile you are trying to retrieve.

Returns:

The PlayerProfile of this player

fromUUID

public static boolean fromUUID(UUID uuid,
                               Consumer<PlayerProfile> callback)

get

public static PlayerProfile get(OfflinePlayer p)

This is now deprecated, use get(OfflinePlayer, Consumer) instead

Parameters:

p - The player's profile you wish to retrieve

Returns:

The PlayerProfile of this player

get

public static boolean get(OfflinePlayer p,
                          Consumer<PlayerProfile> callback)

Get the PlayerProfile for a player asynchronously.

Parameters:

p - The player who's profile to retrieve

callback - The callback with the PlayerProfile

Returns:

If the player was cached or not.

isLoaded

public static boolean isLoaded(UUID uuid)

find

public static Optional<PlayerProfile> find(OfflinePlayer p)

iterator

public static Iterator<PlayerProfile> iterator()

getBackpack

public static PlayerBackpack getBackpack(ItemStack item)

toString

public String toString()

Overrides:

toString in class Object