Class InvseeAPI

java.lang.Object

com.janboerman.invsee.spigot.api.InvseeAPI

public class InvseeAPI
extends Object

InvSee++'s api main entrypoint. Instance can be obtained via:

InvseePlusPlus plugin = (InvseePlusPlus) Bukkit.getPluginManager().getPlugin("InvSeePlusPlus");
InvseeAPI api = plugin.getApi();

Field Summary

Fields

Modifier and Type	Field	Description
final Executor	asyncExecutor	Deprecated. use getScheduler() instead
protected Mirror<EnderChestSlot>	enderchestMirror
protected final Exempt	exempt
protected final com.janboerman.invsee.spigot.api.InvseeAPI.InventoryListener	inventoryListener
protected Mirror<PlayerInventorySlot>	inventoryMirror
protected final NamesAndUUIDs	lookup
protected final OpenSpectatorsCache	openSpectatorsCache
protected final InvseePlatform	platform
protected final com.janboerman.invsee.spigot.api.InvseeAPI.PlayerListener	playerListener
protected final Plugin	plugin
final Executor	serverThreadExecutor	Deprecated. use getScheduler() instead

Constructor Summary

Constructors

Constructor	Description
InvseeAPI(Plugin plugin, InvseePlatform platform, NamesAndUUIDs lookup, Scheduler scheduler, OpenSpectatorsCache openSpectatorsCache)	Deprecated. internal api

Method Summary

Modifier and Type	Method	Description
protected void	cache(EnderSpectatorInventory spectatorInventory)	Deprecated. internal api
protected void	cache(EnderSpectatorInventory spectatorInventory, boolean force)	Deprecated. internal api
protected void	cache(MainSpectatorInventory spectatorInventory)	Deprecated. internal api
protected void	cache(MainSpectatorInventory spectatorInventory, boolean force)	Deprecated. internal api
final CompletableFuture<Optional<EnderSpectatorInventory>>	createOfflineEnderChest(UUID playerId, String playerName, String title)	Deprecated. use enderSpectatorInventory(UUID, String, CreationOptions)
final CompletableFuture<Optional<EnderSpectatorInventory>>	createOfflineEnderChest(UUID playerId, String playerName, String title, Mirror<EnderChestSlot> mirror)	Deprecated. use enderSpectatorInventory(UUID, String, CreationOptions)
final CompletableFuture<Optional<MainSpectatorInventory>>	createOfflineInventory(UUID playerId, String playerName, String title)	Deprecated. use mainSpectatorInventory(UUID, String, CreationOptions)
final CompletableFuture<Optional<MainSpectatorInventory>>	createOfflineInventory(UUID playerId, String playerName, String title, Mirror<PlayerInventorySlot> mirror)	Deprecated. use mainSpectatorInventory(UUID, String, CreationOptions)
CreationOptions<EnderChestSlot>	enderInventoryCreationOptions()	Get the configured CreationOptions for EnderSpectatorInventorys.
CreationOptions<EnderChestSlot>	enderInventoryCreationOptions(Player spectator)	Get the configured CreationOptions for EnderSpectatorInventorys.
final CompletableFuture<SpectateResponse<EnderSpectatorInventory>>	enderSpectatorInventory(String targetName)	Create an EnderSpectatorInventory which will provide access to the ender chest contents of a target player.
final CompletableFuture<SpectateResponse<EnderSpectatorInventory>>	enderSpectatorInventory(String targetName, CreationOptions<EnderChestSlot> options)	Create an EnderSpectatorInventory which will provide access to the ender chest contents of a target player.
final CompletableFuture<SpectateResponse<EnderSpectatorInventory>>	enderSpectatorInventory(String targetName, String title)	Deprecated. use enderSpectatorInventory(String, CreationOptions)
final CompletableFuture<SpectateResponse<EnderSpectatorInventory>>	enderSpectatorInventory(String targetName, String title, boolean offlineSupport)	Deprecated. use enderSpectatorInventory(String, CreationOptions)
final CompletableFuture<SpectateResponse<EnderSpectatorInventory>>	enderSpectatorInventory(String targetName, String title, boolean offlineSupport, Mirror<EnderChestSlot> mirror)	Deprecated. use enderSpectatorInventory(String, CreationOptions)
final CompletableFuture<SpectateResponse<EnderSpectatorInventory>>	enderSpectatorInventory(UUID playerId, String playerName)	Create an EnderSpectatorInventory which will provide access to the ender chest contents of a target player.
final CompletableFuture<SpectateResponse<EnderSpectatorInventory>>	enderSpectatorInventory(UUID playerId, String playerName, CreationOptions<EnderChestSlot> options)	Create an EnderSpectatorInventory which will provide access to the ender chest contents of a target player.
final CompletableFuture<SpectateResponse<EnderSpectatorInventory>>	enderSpectatorInventory(UUID playerId, String playerName, String title)	Deprecated. use enderSpectatorInventory(UUID, String, CreationOptions)
final CompletableFuture<SpectateResponse<EnderSpectatorInventory>>	enderSpectatorInventory(UUID playerId, String playerName, String title, boolean offlineSupport)	Deprecated. use enderSpectatorInventory(UUID, String, CreationOptions)
final CompletableFuture<SpectateResponse<EnderSpectatorInventory>>	enderSpectatorInventory(UUID playerId, String playerName, String title, boolean offlineSupport, Mirror<EnderChestSlot> mirror)	Deprecated. use enderSpectatorInventory(UUID, String, CreationOptions)
final SpectateResponse<EnderSpectatorInventory>	enderSpectatorInventory(HumanEntity target)	Create an EnderSpectatorInventory which will provide access to the ender chest contents of a target player.
final SpectateResponse<EnderSpectatorInventory>	enderSpectatorInventory(HumanEntity target, CreationOptions<EnderChestSlot> options)	Create an EnderSpectatorInventory which will provide access to the ender chest contents of a target player.
final SpectateResponse<EnderSpectatorInventory>	enderSpectatorInventory(HumanEntity target, String title)	Deprecated. use enderSpectatorInventory(HumanEntity, CreationOptions)
final SpectateResponse<EnderSpectatorInventory>	enderSpectatorInventory(HumanEntity target, String title, Mirror<EnderChestSlot> mirror)	Deprecated. use enderSpectatorInventory(HumanEntity, CreationOptions)
final CompletableFuture<Optional<UUID>>	fetchUniqueId(String userName)	Fetches the unique ID of the player with the provided username.
final CompletableFuture<Optional<String>>	fetchUserName(UUID uniqueId)	Fetches the username of the player with the provided unique ID.
Optional<EnderSpectatorInventory>	getOpenEnderSpectatorInventory(UUID player)	Deprecated. internal api
Optional<MainSpectatorInventory>	getOpenMainSpectatorInventory(UUID player)	Deprecated. internal api
protected InvseePlatform	getPlatform()	Deprecated.
Scheduler	getScheduler()
Map<UUID,String>	getUserNameCache()	Get the known mappings from players' unique IDs to usernames.
Map<String,UUID>	getUuidCache()	Get the known mappings from players' usernames to unique IDs.
CreationOptions<PlayerInventorySlot>	mainInventoryCreationOptions()	Get the configured CreationOptions for MainSpectatorInventorys.
CreationOptions<PlayerInventorySlot>	mainInventoryCreationOptions(Player spectator)	Get the configured CreationOptions for MainSpectatorInventorys.
final CompletableFuture<SpectateResponse<MainSpectatorInventory>>	mainSpectatorInventory(String targetName)	Create a MainSpectatorInventory which will provide access to the inventory contents of a target player.
final CompletableFuture<SpectateResponse<MainSpectatorInventory>>	mainSpectatorInventory(String targetName, CreationOptions<PlayerInventorySlot> options)	Create a MainSpectatorInventory which will provide access to the inventory contents of a target player.
final CompletableFuture<SpectateResponse<MainSpectatorInventory>>	mainSpectatorInventory(String targetName, String title)	Deprecated. use mainSpectatorInventory(String, CreationOptions)
final CompletableFuture<SpectateResponse<MainSpectatorInventory>>	mainSpectatorInventory(String targetName, String title, boolean offlineSupport)	Deprecated. use mainSpectatorInventory(String, CreationOptions)
final CompletableFuture<SpectateResponse<MainSpectatorInventory>>	mainSpectatorInventory(String targetName, String title, boolean offlineSupport, Mirror<PlayerInventorySlot> mirror)	Deprecated. use mainSpectatorInventory(String, CreationOptions)
final CompletableFuture<SpectateResponse<MainSpectatorInventory>>	mainSpectatorInventory(UUID playerId, String playerName)	Create a MainSpectatorInventory which will provide access to the inventory contents of a target player.
final CompletableFuture<SpectateResponse<MainSpectatorInventory>>	mainSpectatorInventory(UUID playerId, String playerName, CreationOptions<PlayerInventorySlot> options)	Create a MainSpectatorInventory which will provide access to the inventory contents of a target player.
final CompletableFuture<SpectateResponse<MainSpectatorInventory>>	mainSpectatorInventory(UUID playerId, String playerName, String title)	Deprecated. use mainSpectatorInventory(UUID, String, CreationOptions)
final CompletableFuture<SpectateResponse<MainSpectatorInventory>>	mainSpectatorInventory(UUID playerId, String playerName, String title, boolean offlineSupport)	Deprecated. use mainSpectatorInventory(UUID, String, CreationOptions)
final CompletableFuture<SpectateResponse<MainSpectatorInventory>>	mainSpectatorInventory(UUID playerId, String playerName, String title, boolean offlineSupport, Mirror<PlayerInventorySlot> mirror)	Deprecated. use mainSpectatorInventory(UUID, String, CreationOptions)
final SpectateResponse<MainSpectatorInventory>	mainSpectatorInventory(HumanEntity target)	Create a MainSpectatorInventory which will provide access to the inventory contents of a target player.
final SpectateResponse<MainSpectatorInventory>	mainSpectatorInventory(HumanEntity target, CreationOptions<PlayerInventorySlot> options)	Create a MainSpectatorInventory which will provide access to the inventory contents of a target player.
final SpectateResponse<MainSpectatorInventory>	mainSpectatorInventory(HumanEntity target, String title)	Deprecated. use mainSpectatorInventory(HumanEntity, CreationOptions)
final SpectateResponse<MainSpectatorInventory>	mainSpectatorInventory(HumanEntity target, String title, Mirror<PlayerInventorySlot> mirror)	Deprecated. use mainSpectatorInventory(HumanEntity, CreationOptions)
final NamesAndUUIDs	namesAndUuidsLookup()	Deprecated. Unstable api
final boolean	offlinePlayerSupport()	Get whether the CreationOptions returned by mainInventoryCreationOptions() and enderInventoryCreationOptions() will support spectating offline players.
final void	openEnderSpectatorInventory(Player spectator, EnderSpectatorInventory spectatorInventory, String title, Mirror<EnderChestSlot> mirror)	Deprecated. use spectateEnderChest(Player, HumanEntity, CreationOptions) or spectateEnderChest(Player, UUID, String, CreationOptions)
final void	openMainSpectatorInventory(Player spectator, MainSpectatorInventory spectatorInventory, String title, Mirror<PlayerInventorySlot> mirror)	Deprecated. use spectateInventory(Player, HumanEntity, CreationOptions) or spectateInventory(Player, UUID, String, CreationOptions)
void	registerListeners()	Deprecated. internal api, subject to change
CompletableFuture<SaveResponse>	saveEnderChest(EnderSpectatorInventory enderChest)	Save the target player's ender chest contents to his/her player data file.
CompletableFuture<SaveResponse>	saveInventory(MainSpectatorInventory inventory)	Save the target player's inventory contents to his/her player data file.
final void	setEnderChestTransferPredicate(BiPredicate<EnderSpectatorInventory, Player> bip)	Deprecated. internal api
final void	setEnderInventoryMirror(Mirror<EnderChestSlot> mirror)	Set the Mirror to be used by enderInventoryCreationOptions().
final void	setEnderInventoryTitle(Title title)	Set the Title to be used by enderInventoryCreationOptions().
final void	setEnderInventoryTitleFactory(Function<Target,String> titleFactory)	Deprecated. use setEnderInventoryTitle(Title)
final void	setLogOptions(LogOptions options)	Set the LogOptions to be used by mainInventoryCreationOptions() and enderInventoryCreationOptions().
final void	setMainInventoryMirror(Mirror<PlayerInventorySlot> mirror)	Set the Mirror to be used by mainInventoryCreationOptions().
final void	setMainInventoryTitle(Title title)	Set the Title to be used by mainInventoryCreationOptions().
final void	setMainInventoryTitleFactory(Function<Target,String> titleFactory)	Deprecated. use setMainInventoryTitle(Title)
final void	setMainInventoryTransferPredicate(BiPredicate<MainSpectatorInventory, Player> bip)	Deprecated. internal api
final void	setOfflinePlayerSupport(boolean offlinePlayerSupport)	Set the offline player support status for mainInventoryCreationOptions() and enderInventoryCreationOptions().
final void	setPlaceholderPalette(PlaceholderPalette palette)	Set the PlaceholderPalette that will be used for placeholders for absent items in non-container slots.
final void	setUnknownPlayerSupport(boolean unknownPlayerSupport)	Set the unknown player support status for mainInventoryCreationOptions() and enderInventoryCreationOptions().
void	shutDown()	Called when InvSee++ disables.
final EnderSpectatorInventory	spectateEnderChest(HumanEntity player, String title)	Deprecated. use enderSpectatorInventory(HumanEntity, CreationOptions)
final EnderSpectatorInventory	spectateEnderChest(HumanEntity player, String title, Mirror<EnderChestSlot> mirror)	Deprecated. use enderSpectatorInventory(HumanEntity, CreationOptions)
final CompletableFuture<OpenResponse<EnderSpectatorInventoryView>>	spectateEnderChest(Player spectator, String targetName, CreationOptions<EnderChestSlot> options)	Opens an EnderSpectatorInventory for a player.
final CompletableFuture<Void>	spectateEnderChest(Player spectator, String targetName, String title, boolean offlineSupport, Mirror<EnderChestSlot> mirror)	Deprecated. use spectateEnderChest(Player, String, CreationOptions)
final CompletableFuture<OpenResponse<EnderSpectatorInventoryView>>	spectateEnderChest(Player spectator, UUID targetId, String targetName, CreationOptions<EnderChestSlot> options)	Opens an EnderSpectatorInventory for a player.
final CompletableFuture<Void>	spectateEnderChest(Player spectator, UUID targetId, String targetName, String title, boolean offlineSupport, Mirror<EnderChestSlot> mirror)	Deprecated. use spectateEnderChest(Player, UUID, String, CreationOptions)
final OpenResponse<EnderSpectatorInventoryView>	spectateEnderChest(Player spectator, HumanEntity target, CreationOptions<EnderChestSlot> options)	Opens an EnderSpectatorInventory for a player.
final MainSpectatorInventory	spectateInventory(HumanEntity player, String title)	Deprecated. use mainSpectatorInventory(HumanEntity, CreationOptions)
final MainSpectatorInventory	spectateInventory(HumanEntity player, String title, Mirror<PlayerInventorySlot> mirror)	Deprecated. use mainSpectatorInventory(HumanEntity, CreationOptions)
final CompletableFuture<OpenResponse<MainSpectatorInventoryView>>	spectateInventory(Player spectator, String targetName, CreationOptions<PlayerInventorySlot> options)	Opens a MainSpectatorInventory for a player.
final CompletableFuture<Void>	spectateInventory(Player spectator, String targetName, String title, boolean offlineSupport, Mirror<PlayerInventorySlot> mirror)	Deprecated. use spectateInventory(Player, String, CreationOptions)
final CompletableFuture<OpenResponse<MainSpectatorInventoryView>>	spectateInventory(Player spectator, UUID targetId, String targetName, CreationOptions<PlayerInventorySlot> options)	Opens a MainSpectatorInventory for a player.
final CompletableFuture<Void>	spectateInventory(Player spectator, UUID targetId, String targetName, String title, boolean offlineSupport, Mirror<PlayerInventorySlot> mirror)	Deprecated. use spectateInventory(Player, UUID, String, CreationOptions)
final OpenResponse<MainSpectatorInventoryView>	spectateInventory(Player spectator, HumanEntity target, CreationOptions<PlayerInventorySlot> options)	Opens a MainSpectatorInventory for a player.
final boolean	unknownPlayerSupport()	Get whether the CreationOptions returned by mainInventoryCreationOptions() and enderInventoryCreationOptions() will support spectating unknown players.
void	unregisterListeners()	Deprecated. internal api, subject to change

Methods inherited from class Object

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

Field Details

plugin

protected final Plugin plugin

platform

protected final InvseePlatform platform

lookup

protected final NamesAndUUIDs lookup

openSpectatorsCache

protected final OpenSpectatorsCache openSpectatorsCache

exempt

protected final Exempt exempt

inventoryMirror

protected Mirror<PlayerInventorySlot> inventoryMirror

enderchestMirror

protected Mirror<EnderChestSlot> enderchestMirror

serverThreadExecutor

@Deprecated
public final Executor serverThreadExecutor

Deprecated.

use getScheduler() instead

asyncExecutor

@Deprecated
public final Executor asyncExecutor

Deprecated.

use getScheduler() instead

playerListener

protected final com.janboerman.invsee.spigot.api.InvseeAPI.PlayerListener playerListener

inventoryListener

protected final com.janboerman.invsee.spigot.api.InvseeAPI.InventoryListener inventoryListener

Constructor Details

InvseeAPI

public InvseeAPI(Plugin plugin,
 InvseePlatform platform,
 NamesAndUUIDs lookup,
 Scheduler scheduler,
 OpenSpectatorsCache openSpectatorsCache)

Deprecated.

internal api

Method Details

getScheduler

public Scheduler getScheduler()

API Note:

unstable api

getPlatform

@Deprecated
protected InvseePlatform getPlatform()

Deprecated.

shutDown

public void shutDown()

Called when InvSee++ disables. DO NOT CALL!

getUuidCache

public Map<String,UUID> getUuidCache()

Get the known mappings from players' usernames to unique IDs.

getUserNameCache

public Map<UUID,String> getUserNameCache()

Get the known mappings from players' unique IDs to usernames.

namesAndUuidsLookup

@Deprecated
public final NamesAndUUIDs namesAndUuidsLookup()

Deprecated.

Unstable api

registerListeners

public void registerListeners()

Deprecated.

internal api, subject to change

unregisterListeners

public void unregisterListeners()

Deprecated.

internal api, subject to change

setOfflinePlayerSupport

public final void setOfflinePlayerSupport(boolean offlinePlayerSupport)

Set the offline player support status for mainInventoryCreationOptions() and enderInventoryCreationOptions().

setUnknownPlayerSupport

public final void setUnknownPlayerSupport(boolean unknownPlayerSupport)

Set the unknown player support status for mainInventoryCreationOptions() and enderInventoryCreationOptions().

offlinePlayerSupport

public final boolean offlinePlayerSupport()

Get whether the CreationOptions returned by mainInventoryCreationOptions() and enderInventoryCreationOptions() will support spectating offline players.

unknownPlayerSupport

public final boolean unknownPlayerSupport()

Get whether the CreationOptions returned by mainInventoryCreationOptions() and enderInventoryCreationOptions() will support spectating unknown players.

setMainInventoryTitle

public final void setMainInventoryTitle(Title title)

Set the Title to be used by mainInventoryCreationOptions().

setEnderInventoryTitle

public final void setEnderInventoryTitle(Title title)

Set the Title to be used by enderInventoryCreationOptions().

setMainInventoryMirror

public final void setMainInventoryMirror(Mirror<PlayerInventorySlot> mirror)

Set the Mirror to be used by mainInventoryCreationOptions().

setEnderInventoryMirror

public final void setEnderInventoryMirror(Mirror<EnderChestSlot> mirror)

Set the Mirror to be used by enderInventoryCreationOptions().

setLogOptions

public final void setLogOptions(LogOptions options)

Set the LogOptions to be used by mainInventoryCreationOptions() and enderInventoryCreationOptions().

setPlaceholderPalette

public final void setPlaceholderPalette(PlaceholderPalette palette)

Set the PlaceholderPalette that will be used for placeholders for absent items in non-container slots.

mainInventoryCreationOptions

public CreationOptions<PlayerInventorySlot> mainInventoryCreationOptions(Player spectator)

Get the configured CreationOptions for MainSpectatorInventorys.

Parameters:

spectator - the spectating player

Returns:

the creation options

enderInventoryCreationOptions

public CreationOptions<EnderChestSlot> enderInventoryCreationOptions(Player spectator)

Get the configured CreationOptions for EnderSpectatorInventorys.

Parameters:

spectator - the spectating player

Returns:

the creation options

mainInventoryCreationOptions

public CreationOptions<PlayerInventorySlot> mainInventoryCreationOptions()

Get the configured CreationOptions for MainSpectatorInventorys. These creation options will always bypass the target's exemption status.

Returns:

the creation options

enderInventoryCreationOptions

public CreationOptions<EnderChestSlot> enderInventoryCreationOptions()

Get the configured CreationOptions for EnderSpectatorInventorys. These creation options will always bypass the target's exemption status.

Returns:

the creation options

setMainInventoryTransferPredicate

public final void setMainInventoryTransferPredicate(BiPredicate<MainSpectatorInventory, Player> bip)

Deprecated.

internal api

setEnderChestTransferPredicate

public final void setEnderChestTransferPredicate(BiPredicate<EnderSpectatorInventory, Player> bip)

Deprecated.

internal api

getOpenMainSpectatorInventory

@Deprecated
public Optional<MainSpectatorInventory> getOpenMainSpectatorInventory(UUID player)

Deprecated.

internal api

Get a cached MainSpectatorInventory for the target player.

getOpenEnderSpectatorInventory

@Deprecated
public Optional<EnderSpectatorInventory> getOpenEnderSpectatorInventory(UUID player)

Deprecated.

internal api

Get a cached EnderSpectatorInventory for the target player.

fetchUniqueId

public final CompletableFuture<Optional<UUID>> fetchUniqueId(String userName)

Fetches the unique ID of the player with the provided username.

See Also:

• NamesAndUUIDs

fetchUserName

public final CompletableFuture<Optional<String>> fetchUserName(UUID uniqueId)

Fetches the username of the player with the provided unique ID.

See Also:

• NamesAndUUIDs

cache

@Deprecated
protected void cache(MainSpectatorInventory spectatorInventory)

Deprecated.

internal api

cache

@Deprecated
protected void cache(MainSpectatorInventory spectatorInventory,
 boolean force)

Deprecated.

internal api

cache

@Deprecated
protected void cache(EnderSpectatorInventory spectatorInventory)

Deprecated.

internal api

cache

@Deprecated
protected void cache(EnderSpectatorInventory spectatorInventory,
 boolean force)

Deprecated.

internal api

saveInventory

public CompletableFuture<SaveResponse> saveInventory(MainSpectatorInventory inventory)

Save the target player's inventory contents to his/her player data file.

Parameters:

inventory - the inventory contents

Returns:

a future which completes once the contents is saved

spectateInventory

public final OpenResponse<MainSpectatorInventoryView> spectateInventory(Player spectator,
 HumanEntity target,
 CreationOptions<PlayerInventorySlot> options)

Opens a MainSpectatorInventory for a player.

Parameters:

spectator - the spectating player

target - the target player

options - the creation options

Returns:

an OpenResponse which, if successful, gives access to an MainSpectatorInventoryView which represents the open window

mainSpectatorInventory

public final SpectateResponse<MainSpectatorInventory> mainSpectatorInventory(HumanEntity target)

Create a MainSpectatorInventory which will provide access to the inventory contents of a target player.

Parameters:

target - the target player

Returns:

a SpectateResponse which, if successful, will give access to the MainSpectatorInventory

mainSpectatorInventory

public final SpectateResponse<MainSpectatorInventory> mainSpectatorInventory(HumanEntity target,
 CreationOptions<PlayerInventorySlot> options)

Create a MainSpectatorInventory which will provide access to the inventory contents of a target player.

Parameters:

target - the target player

options - the creation options

Returns:

a SpectateResponse which, if successful, will give access to the MainSpectatorInventory

spectateInventory

public final CompletableFuture<OpenResponse<MainSpectatorInventoryView>> spectateInventory(Player spectator,
 String targetName,
 CreationOptions<PlayerInventorySlot> options)

Opens a MainSpectatorInventory for a player.

Parameters:

spectator - the spectating player

targetName - the name of the target player

options - the creation options

Returns:

a future which will complete with an OpenResponse which, if successful, gives access to an MainSpectatorInventoryView which represents the open window

mainSpectatorInventory

public final CompletableFuture<SpectateResponse<MainSpectatorInventory>> mainSpectatorInventory(String targetName)

Create a MainSpectatorInventory which will provide access to the inventory contents of a target player.

Parameters:

targetName - the username of the target player

Returns:

a future which will complete with a SpectateResponse which, if successful, will give access to the MainSpectatorInventory

mainSpectatorInventory

public final CompletableFuture<SpectateResponse<MainSpectatorInventory>> mainSpectatorInventory(String targetName,
 CreationOptions<PlayerInventorySlot> options)

Create a MainSpectatorInventory which will provide access to the inventory contents of a target player.

Parameters:

targetName - the username of the target player

options - the creation options

Returns:

a future which will complete with a SpectateResponse which, if successful, will give access to the MainSpectatorInventory

spectateInventory

public final CompletableFuture<OpenResponse<MainSpectatorInventoryView>> spectateInventory(Player spectator,
 UUID targetId,
 String targetName,
 CreationOptions<PlayerInventorySlot> options)

Opens a MainSpectatorInventory for a player.

Parameters:

spectator - the spectating player

targetId - the unique ID of the target player

targetName - the name of the target player

options - the creation options

Returns:

a future which will complete with an OpenResponse which, if successful, gives access to an MainSpectatorInventoryView which represents the open window

mainSpectatorInventory

public final CompletableFuture<SpectateResponse<MainSpectatorInventory>> mainSpectatorInventory(UUID playerId,
 String playerName)

Create a MainSpectatorInventory which will provide access to the inventory contents of a target player.

Parameters:

playerId - the unique ID of the target player

playerName - the username of the target player

Returns:

a future which will complete with a SpectateResponse which, if successful, will give access to the MainSpectatorInventory

mainSpectatorInventory

public final CompletableFuture<SpectateResponse<MainSpectatorInventory>> mainSpectatorInventory(UUID playerId,
 String playerName,
 CreationOptions<PlayerInventorySlot> options)

Create a MainSpectatorInventory which will provide access to the inventory contents of a target player.

Parameters:

playerId - the unique ID of the target player

playerName - the username of the target player

options - the creation options

Returns:

a future which will complete with a SpectateResponse which, if successful, will give access to the MainSpectatorInventory

saveEnderChest

public CompletableFuture<SaveResponse> saveEnderChest(EnderSpectatorInventory enderChest)

Save the target player's ender chest contents to his/her player data file.

Parameters:

enderChest - the ender chest contents

Returns:

a future which completes once the contents is saved

spectateEnderChest

public final OpenResponse<EnderSpectatorInventoryView> spectateEnderChest(Player spectator,
 HumanEntity target,
 CreationOptions<EnderChestSlot> options)

Opens an EnderSpectatorInventory for a player.

Parameters:

spectator - the spectating player

target - the target player

options - the creation options

Returns:

an OpenResponse which, if successful, gives access to an EnderSpectatorInventoryView which represents the open window

enderSpectatorInventory

public final SpectateResponse<EnderSpectatorInventory> enderSpectatorInventory(HumanEntity target)

Create an EnderSpectatorInventory which will provide access to the ender chest contents of a target player.

Parameters:

target - the target player

Returns:

a SpectateResponse which, if successful, will give access to the EnderSpectatorInventory

enderSpectatorInventory

public final SpectateResponse<EnderSpectatorInventory> enderSpectatorInventory(HumanEntity target,
 CreationOptions<EnderChestSlot> options)

Create an EnderSpectatorInventory which will provide access to the ender chest contents of a target player.

Parameters:

target - the target player

options - the creation options

Returns:

a SpectateResponse which, if successful, will give access to the EnderSpectatorInventory

spectateEnderChest

public final CompletableFuture<OpenResponse<EnderSpectatorInventoryView>> spectateEnderChest(Player spectator,
 String targetName,
 CreationOptions<EnderChestSlot> options)

Opens an EnderSpectatorInventory for a player.

Parameters:

spectator - the spectating player

targetName - the name of the target player

options - the creation options

Returns:

a future which will complete with an OpenResponse which, if successful, gives access to an EnderSpectatorInventoryView which represents the open window

enderSpectatorInventory

public final CompletableFuture<SpectateResponse<EnderSpectatorInventory>> enderSpectatorInventory(String targetName)

Create an EnderSpectatorInventory which will provide access to the ender chest contents of a target player.

Parameters:

targetName - the username of the target player

Returns:

a future which will complete with a SpectateResponse which, if successful, will give access to the EnderSpectatorInventory

enderSpectatorInventory

public final CompletableFuture<SpectateResponse<EnderSpectatorInventory>> enderSpectatorInventory(String targetName,
 CreationOptions<EnderChestSlot> options)

Create an EnderSpectatorInventory which will provide access to the ender chest contents of a target player.

Parameters:

targetName - the username of the target player

options - the creation options

Returns:

a future which will complete with a SpectateResponse which, if successful, will give access to the EnderSpectatorInventory

spectateEnderChest

public final CompletableFuture<OpenResponse<EnderSpectatorInventoryView>> spectateEnderChest(Player spectator,
 UUID targetId,
 String targetName,
 CreationOptions<EnderChestSlot> options)

Opens an EnderSpectatorInventory for a player.

Parameters:

spectator - the spectating player

targetId - the unique ID of the target player

targetName - the name of the target player

options - the creation options

Returns:

a future which will complete with an OpenResponse which, if successful, gives access to an EnderSpectatorInventoryView which represents the open window

enderSpectatorInventory

public final CompletableFuture<SpectateResponse<EnderSpectatorInventory>> enderSpectatorInventory(UUID playerId,
 String playerName)

Create an EnderSpectatorInventory which will provide access to the ender chest contents of a target player.

Parameters:

playerId - the unique ID of the target player

playerName - the username of the target player

Returns:

a future which will complete with a SpectateResponse which, if successful, will give access to the EnderSpectatorInventory

enderSpectatorInventory

public final CompletableFuture<SpectateResponse<EnderSpectatorInventory>> enderSpectatorInventory(UUID playerId,
 String playerName,
 CreationOptions<EnderChestSlot> options)

Create an EnderSpectatorInventory which will provide access to the ender chest contents of a target player.

Parameters:

playerId - the unique ID of the target player

playerName - the username of the target player

options - the creation options

Returns:

a future which will complete with a SpectateResponse which, if successful, will give access to the EnderSpectatorInventory

setMainInventoryTitleFactory

@Deprecated
public final void setMainInventoryTitleFactory(Function<Target,String> titleFactory)

Deprecated.

use setMainInventoryTitle(Title)

setEnderInventoryTitleFactory

@Deprecated
public final void setEnderInventoryTitleFactory(Function<Target,String> titleFactory)

Deprecated.

use setEnderInventoryTitle(Title)

spectateInventory

@Deprecated
public final CompletableFuture<Void> spectateInventory(Player spectator,
 String targetName,
 String title,
 boolean offlineSupport,
 Mirror<PlayerInventorySlot> mirror)

Deprecated.

use spectateInventory(Player, String, CreationOptions)

spectateInventory

@Deprecated
public final CompletableFuture<Void> spectateInventory(Player spectator,
 UUID targetId,
 String targetName,
 String title,
 boolean offlineSupport,
 Mirror<PlayerInventorySlot> mirror)

Deprecated.

use spectateInventory(Player, UUID, String, CreationOptions)

spectateEnderChest

@Deprecated
public final CompletableFuture<Void> spectateEnderChest(Player spectator,
 String targetName,
 String title,
 boolean offlineSupport,
 Mirror<EnderChestSlot> mirror)

Deprecated.

use spectateEnderChest(Player, String, CreationOptions)

spectateEnderChest

@Deprecated
public final CompletableFuture<Void> spectateEnderChest(Player spectator,
 UUID targetId,
 String targetName,
 String title,
 boolean offlineSupport,
 Mirror<EnderChestSlot> mirror)

Deprecated.

use spectateEnderChest(Player, UUID, String, CreationOptions)

mainSpectatorInventory

@Deprecated
public final SpectateResponse<MainSpectatorInventory> mainSpectatorInventory(HumanEntity target,
 String title)

Deprecated.

use mainSpectatorInventory(HumanEntity, CreationOptions)

mainSpectatorInventory

@Deprecated
public final SpectateResponse<MainSpectatorInventory> mainSpectatorInventory(HumanEntity target,
 String title,
 Mirror<PlayerInventorySlot> mirror)

Deprecated.

use mainSpectatorInventory(HumanEntity, CreationOptions)

mainSpectatorInventory

@Deprecated
public final CompletableFuture<SpectateResponse<MainSpectatorInventory>> mainSpectatorInventory(String targetName,
 String title)

Deprecated.

use mainSpectatorInventory(String, CreationOptions)

mainSpectatorInventory

@Deprecated
public final CompletableFuture<SpectateResponse<MainSpectatorInventory>> mainSpectatorInventory(String targetName,
 String title,
 boolean offlineSupport)

Deprecated.

use mainSpectatorInventory(String, CreationOptions)

mainSpectatorInventory

@Deprecated
public final CompletableFuture<SpectateResponse<MainSpectatorInventory>> mainSpectatorInventory(String targetName,
 String title,
 boolean offlineSupport,
 Mirror<PlayerInventorySlot> mirror)

Deprecated.

use mainSpectatorInventory(String, CreationOptions)

mainSpectatorInventory

@Deprecated
public final CompletableFuture<SpectateResponse<MainSpectatorInventory>> mainSpectatorInventory(UUID playerId,
 String playerName,
 String title)

Deprecated.

use mainSpectatorInventory(UUID, String, CreationOptions)

mainSpectatorInventory

@Deprecated
public final CompletableFuture<SpectateResponse<MainSpectatorInventory>> mainSpectatorInventory(UUID playerId,
 String playerName,
 String title,
 boolean offlineSupport)

Deprecated.

use mainSpectatorInventory(UUID, String, CreationOptions)

mainSpectatorInventory

@Deprecated
public final CompletableFuture<SpectateResponse<MainSpectatorInventory>> mainSpectatorInventory(UUID playerId,
 String playerName,
 String title,
 boolean offlineSupport,
 Mirror<PlayerInventorySlot> mirror)

Deprecated.

use mainSpectatorInventory(UUID, String, CreationOptions)

enderSpectatorInventory

@Deprecated
public final SpectateResponse<EnderSpectatorInventory> enderSpectatorInventory(HumanEntity target,
 String title)

Deprecated.

use enderSpectatorInventory(HumanEntity, CreationOptions)

enderSpectatorInventory

@Deprecated
public final SpectateResponse<EnderSpectatorInventory> enderSpectatorInventory(HumanEntity target,
 String title,
 Mirror<EnderChestSlot> mirror)

Deprecated.

use enderSpectatorInventory(HumanEntity, CreationOptions)

enderSpectatorInventory

@Deprecated
public final CompletableFuture<SpectateResponse<EnderSpectatorInventory>> enderSpectatorInventory(String targetName,
 String title)

Deprecated.

use enderSpectatorInventory(String, CreationOptions)

enderSpectatorInventory

@Deprecated
public final CompletableFuture<SpectateResponse<EnderSpectatorInventory>> enderSpectatorInventory(String targetName,
 String title,
 boolean offlineSupport)

Deprecated.

use enderSpectatorInventory(String, CreationOptions)

enderSpectatorInventory

@Deprecated
public final CompletableFuture<SpectateResponse<EnderSpectatorInventory>> enderSpectatorInventory(String targetName,
 String title,
 boolean offlineSupport,
 Mirror<EnderChestSlot> mirror)

Deprecated.

use enderSpectatorInventory(String, CreationOptions)

enderSpectatorInventory

@Deprecated
public final CompletableFuture<SpectateResponse<EnderSpectatorInventory>> enderSpectatorInventory(UUID playerId,
 String playerName,
 String title)

Deprecated.

use enderSpectatorInventory(UUID, String, CreationOptions)

enderSpectatorInventory

@Deprecated
public final CompletableFuture<SpectateResponse<EnderSpectatorInventory>> enderSpectatorInventory(UUID playerId,
 String playerName,
 String title,
 boolean offlineSupport)

Deprecated.

use enderSpectatorInventory(UUID, String, CreationOptions)

enderSpectatorInventory

@Deprecated
public final CompletableFuture<SpectateResponse<EnderSpectatorInventory>> enderSpectatorInventory(UUID playerId,
 String playerName,
 String title,
 boolean offlineSupport,
 Mirror<EnderChestSlot> mirror)

Deprecated.

use enderSpectatorInventory(UUID, String, CreationOptions)

openMainSpectatorInventory

@Deprecated
public final void openMainSpectatorInventory(Player spectator,
 MainSpectatorInventory spectatorInventory,
 String title,
 Mirror<PlayerInventorySlot> mirror)

Deprecated.

use spectateInventory(Player, HumanEntity, CreationOptions) or spectateInventory(Player, UUID, String, CreationOptions)

openEnderSpectatorInventory

@Deprecated
public final void openEnderSpectatorInventory(Player spectator,
 EnderSpectatorInventory spectatorInventory,
 String title,
 Mirror<EnderChestSlot> mirror)

Deprecated.

use spectateEnderChest(Player, HumanEntity, CreationOptions) or spectateEnderChest(Player, UUID, String, CreationOptions)

createOfflineEnderChest

@Deprecated
public final CompletableFuture<Optional<EnderSpectatorInventory>> createOfflineEnderChest(UUID playerId,
 String playerName,
 String title,
 Mirror<EnderChestSlot> mirror)

Deprecated.

use enderSpectatorInventory(UUID, String, CreationOptions)

createOfflineEnderChest

@Deprecated
public final CompletableFuture<Optional<EnderSpectatorInventory>> createOfflineEnderChest(UUID playerId,
 String playerName,
 String title)

Deprecated.

use enderSpectatorInventory(UUID, String, CreationOptions)

spectateEnderChest

@Deprecated
public final EnderSpectatorInventory spectateEnderChest(HumanEntity player,
 String title,
 Mirror<EnderChestSlot> mirror)

Deprecated.

use enderSpectatorInventory(HumanEntity, CreationOptions)

spectateEnderChest

@Deprecated
public final EnderSpectatorInventory spectateEnderChest(HumanEntity player,
 String title)

Deprecated.

use enderSpectatorInventory(HumanEntity, CreationOptions)

createOfflineInventory

@Deprecated
public final CompletableFuture<Optional<MainSpectatorInventory>> createOfflineInventory(UUID playerId,
 String playerName,
 String title,
 Mirror<PlayerInventorySlot> mirror)

Deprecated.

use mainSpectatorInventory(UUID, String, CreationOptions)

createOfflineInventory

@Deprecated
public final CompletableFuture<Optional<MainSpectatorInventory>> createOfflineInventory(UUID playerId,
 String playerName,
 String title)

Deprecated.

use mainSpectatorInventory(UUID, String, CreationOptions)

spectateInventory

@Deprecated
public final MainSpectatorInventory spectateInventory(HumanEntity player,
 String title,
 Mirror<PlayerInventorySlot> mirror)

Deprecated.

use mainSpectatorInventory(HumanEntity, CreationOptions)

spectateInventory

@Deprecated
public final MainSpectatorInventory spectateInventory(HumanEntity player,
 String title)

Deprecated.

use mainSpectatorInventory(HumanEntity, CreationOptions)