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

Class PlayerBackpack

java.lang.Object

io.github.thebusybiscuit.slimefun4.api.player.PlayerBackpack

public class PlayerBackpack
extends Object

This class represents the instance of a SlimefunBackpack that is ready to be opened. It holds an actual Inventory and represents the backpack on the level of an individual ItemStack as opposed to the class SlimefunBackpack.

Author:

TheBusyBiscuit

See Also:

• SlimefunBackpack
• BackpackListener

Constructor Summary

Constructors

Constructor	Description
PlayerBackpack(PlayerProfile profile, int id)	Deprecated. Use load(UUID, int, int, HashMap) instead
PlayerBackpack(PlayerProfile profile, int id, int size)	Deprecated. Use newBackpack(UUID, int, int) instead

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	closeForAll()	This will close the Inventory of this backpack for every Player that has opened it.
int	getId()	This returns the id of this PlayerBackpack
Inventory	getInventory()	This method returns the Inventory of this PlayerBackpack
PlayerProfile	getOwner()	Deprecated. Use getOwnerId() instead
UUID	getOwnerId()
int	getSize()	This returns the size of this PlayerBackpack.
static PlayerBackpack	load(UUID ownerId, int id, int size, HashMap<Integer,ItemStack> contents)
void	markDirty()	This method marks the backpack dirty, it will then be queued for an autosave using save()
static PlayerBackpack	newBackpack(UUID ownerId, int id, int size)
void	open(Player... players)	This will open the Inventory of this backpack to every Player that was passed onto this method.
void	save()	Deprecated. Handled by PlayerProfile.save() now
void	setSize(int size)	This will change the current size of this Backpack to the specified size.

Methods inherited from class java.lang.Object

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

Constructor Details

PlayerBackpack

@Deprecated
public PlayerBackpack(@Nonnull
 PlayerProfile profile,
 int id)

Deprecated.

Use load(UUID, int, int, HashMap) instead

This constructor loads an existing Backpack

Parameters:

profile - The PlayerProfile of this Backpack

id - The id of this Backpack

PlayerBackpack

@Deprecated
public PlayerBackpack(@Nonnull
 PlayerProfile profile,
 int id,
 int size)

Deprecated.

Use newBackpack(UUID, int, int) instead

This constructor creates a new Backpack

Parameters:

profile - The PlayerProfile of this Backpack

id - The id of this Backpack

size - The size of this Backpack

Method Details

getId

public int getId()

This returns the id of this PlayerBackpack

Returns:

The id of this PlayerBackpack

getOwner

@Deprecated
@Nonnull
public PlayerProfile getOwner()

Deprecated.

Use getOwnerId() instead

This method returns the PlayerProfile this PlayerBackpack belongs to

Returns:

The owning PlayerProfile

getOwnerId

public UUID getOwnerId()

getSize

public int getSize()

This returns the size of this PlayerBackpack.

Returns:

The size of this PlayerBackpack

getInventory

@Nonnull
public Inventory getInventory()

This method returns the Inventory of this PlayerBackpack

Returns:

The Inventory of this PlayerBackpack

open

public void open(Player... players)

This will open the Inventory of this backpack to every Player that was passed onto this method.

Parameters:

players - The players who this Backpack will be shown to

closeForAll

public CompletableFuture<Void> closeForAll()

This will close the Inventory of this backpack for every Player that has opened it. This process has to run on the main server thread.

Returns:

A CompletableFuture.

setSize

public void setSize(int size)

This will change the current size of this Backpack to the specified size.

Parameters:

size - The new size for this Backpack

save

@Deprecated
public void save()

Deprecated.

Handled by PlayerProfile.save() now

This method will save the contents of this backpack to a File.

markDirty

public void markDirty()

This method marks the backpack dirty, it will then be queued for an autosave using save()

load

@ParametersAreNonnullByDefault
public static PlayerBackpack load(UUID ownerId,
 int id,
 int size,
 HashMap<Integer,ItemStack> contents)

newBackpack

@ParametersAreNonnullByDefault
public static PlayerBackpack newBackpack(UUID ownerId,
 int id,
 int size)