Package dev.drawethree.xprison.api
Interface XPrisonAPI
public interface XPrisonAPI
Main API interface for interacting with the X-Prison plugin modules.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic class
Holder class for the singleton instance. -
Method Summary
Modifier and TypeMethodDescription@NotNull XPrisonAutoMinerAPI
Gets the AutoMiner module API.@NotNull XPrisonAutoSellAPI
Gets the AutoSell module API.@NotNull XPrisonBombsAPI
Gets the Bombs module API.@NotNull XPrisonEnchantsAPI
Gets the Enchants module API.@NotNull XPrisonGangsAPI
Gets the Gangs module API.@NotNull XPrisonGemsAPI
Gets the Gems module API.@NotNull XPrisonHistoryAPI
Gets the History module API.static @NotNull XPrisonAPI
Gets the singleton instance of the XPrisonAPI.@NotNull XPrisonMinesAPI
Gets the Mines module API.@NotNull XPrisonMultipliersAPI
Gets the Multipliers module API.@NotNull XPrisonPickaxeLevelsAPI
Gets the Pickaxe Levels module API.@NotNull XPrisonPrestigesAPI
Gets the Prestiges module API.@NotNull XPrisonRanksAPI
Gets the Ranks module API.@NotNull XPrisonTokensAPI
Gets the Tokens module API.static void
setInstance
(@NotNull XPrisonAPI instance) Sets the singleton instance of the XPrisonAPI.
-
Method Details
-
getAutoMinerApi
Gets the AutoMiner module API.- Returns:
- the AutoMiner API instance
-
getAutoSellApi
Gets the AutoSell module API.- Returns:
- the AutoSell API instance
-
getEnchantsApi
Gets the Enchants module API.- Returns:
- the Enchants API instance
-
getGangsApi
Gets the Gangs module API.- Returns:
- the Gangs API instance
-
getGemsApi
Gets the Gems module API.- Returns:
- the Gems API instance
-
getHistoryApi
Gets the History module API.- Returns:
- the History API instance
-
getMinesApi
Gets the Mines module API.- Returns:
- the Mines API instance
-
getMultipliersApi
Gets the Multipliers module API.- Returns:
- the Multipliers API instance
-
getPickaxeLevelsApi
Gets the Pickaxe Levels module API.- Returns:
- the Pickaxe Levels API instance
-
getPrestigesApi
Gets the Prestiges module API.- Returns:
- the Prestiges API instance
-
getRanksApi
Gets the Ranks module API.- Returns:
- the Ranks API instance
-
getTokensApi
Gets the Tokens module API.- Returns:
- the Tokens API instance
-
getBombsApi
Gets the Bombs module API.- Returns:
- the Bombs API instance
-
getInstance
Gets the singleton instance of the XPrisonAPI.- Returns:
- the XPrisonAPI instance
- Throws:
IllegalStateException
- if the API has not been initialized
-
setInstance
Sets the singleton instance of the XPrisonAPI.- Parameters:
instance
- the API instance to set- Throws:
IllegalStateException
- if the API is already initialized
-