Package net.okocraft.box.api

Interface BoxAPI

public interface BoxAPI

An API of Box.

Method Summary

Modifier and Type	Method	Description
static @NotNull BoxAPI	api()	Gets an instance of BoxAPI.
boolean	canUseBox(@NotNull Player player)	Checks if the specified Player can use Box.
@NotNull BoxAdminCommand	getBoxAdminCommand()	Gets the BoxAdminCommand.
@NotNull BoxCommand	getBoxCommand()	Gets the BoxCommand.
@NotNull BoxPlayerMap	getBoxPlayerMap()	Gets the BoxPlayerMap.
@NotNull CustomDataManager	getCustomDataManager()	Gets the CustomDataManager.
@NotNull EventCallerProvider	getEventCallers()	Gets the EventCallerProvider.
@NotNull FeatureProvider	getFeatureProvider()	Gets the FeatureProvider.
@NotNull ItemManager	getItemManager()	Gets the ItemManager.
@NotNull ListenerSubscriber<net.kyori.adventure.key.Key,BoxEvent,Priority>	getListenerSubscriber()	Gets the ListenerSubscriber.
@NotNull MessageProvider	getMessageProvider()	Gets the MessageProvider.
@NotNull Path	getPluginDirectory()	Gets the path of the plugin directory.
@NotNull BoxScheduler	getScheduler()	Gets the BoxScheduler.
@NotNull StockManager	getStockManager()	Gets the StockManager.
@NotNull UserManager	getUserManager()	Gets the UserManager.
boolean	isDisabledWorld(@NotNull String worldName)	Checks if Box is not available in the specified world name.
boolean	isDisabledWorld(@NotNull World world)	Checks if Box is not available in the specified world.
static boolean	isLoaded()	Checks if BoxAPI is available.
void	reload(@NotNull CommandSender sender)	Reloads box and registered BoxFeatures.

Method Details

api

@NotNull
static @NotNull BoxAPI api()

Gets an instance of BoxAPI.

Returns:

an instance of BoxAPI

Throws:

IllegalStateException - if BoxAPI is not loaded

isLoaded

static boolean isLoaded()

Checks if BoxAPI is available.

Returns:

true if BoxAPI is loaded, otherwise false

getPluginDirectory

@NotNull
@NotNull Path getPluginDirectory()

Gets the path of the plugin directory.

Returns:

the path of the plugin directory

getMessageProvider

@NotNull
@NotNull MessageProvider getMessageProvider()

Gets the MessageProvider.

Returns:

the MessageProvider

getUserManager

@NotNull
@NotNull UserManager getUserManager()

Gets the UserManager.

Returns:

the UserManager

getItemManager

@NotNull
@NotNull ItemManager getItemManager()

Gets the ItemManager.

Returns:

the ItemManager

getStockManager

@NotNull
@NotNull StockManager getStockManager()

Gets the StockManager.

Returns:

the StockManager

getBoxPlayerMap

@NotNull
@NotNull BoxPlayerMap getBoxPlayerMap()

Gets the BoxPlayerMap.

Returns:

the BoxPlayerMap

getEventCallers

@NotNull
@NotNull EventCallerProvider getEventCallers()

Gets the EventCallerProvider.

Returns:

the EventCallerProvider

getListenerSubscriber

@NotNull
@NotNull ListenerSubscriber<net.kyori.adventure.key.Key,BoxEvent,Priority> getListenerSubscriber()

Gets the ListenerSubscriber.

Returns:

the ListenerSubscriber

getCustomDataManager

@NotNull
@NotNull CustomDataManager getCustomDataManager()

Gets the CustomDataManager.

Returns:

the CustomDataManager

getFeatureProvider

@NotNull
@NotNull FeatureProvider getFeatureProvider()

Gets the FeatureProvider.

Returns:

the FeatureProvider

getScheduler

@NotNull
@NotNull BoxScheduler getScheduler()

Gets the BoxScheduler.

Returns:

the BoxScheduler

getBoxCommand

@NotNull
@NotNull BoxCommand getBoxCommand()

Gets the BoxCommand.

Returns:

the BoxCommand

getBoxAdminCommand

@NotNull
@NotNull BoxAdminCommand getBoxAdminCommand()

Gets the BoxAdminCommand.

Returns:

the BoxAdminCommand

reload

void reload(@NotNull
 @NotNull CommandSender sender)

Reloads box and registered BoxFeatures.

This method reloads some settings of Box (such as language and disabled world) and the BoxFeature in which Reloadable is implemented.

Parameters:

sender - the sender who executed reload

canUseBox

boolean canUseBox(@NotNull
 @NotNull Player player)

Checks if the specified Player can use Box.

Parameters:

player - the Player to check

Returns:

true if the Player can use Box, otherwise false

isDisabledWorld

boolean isDisabledWorld(@NotNull
 @NotNull World world)

Checks if Box is not available in the specified world.

Parameters:

world - the world to check

Returns:

if Box is disabled in the specified world, returns true, otherwise false

isDisabledWorld

boolean isDisabledWorld(@NotNull
 @NotNull String worldName)

Checks if Box is not available in the specified world name.

Parameters:

worldName - the world name to check

Returns:

if Box is disabled in the specified world, returns true, otherwise false