Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/BG-Software-LLC/SuperiorSkyblock2/llms.txt

Use this file to discover all available pages before exploring further.

The ProvidersManager allows you to integrate custom providers for various plugin functionalities including spawners, stacked blocks, entities, economy, worlds, and more.

​
Spawners Provider

​
getSpawnersProvider

Get the currently used spawners-provider. 
SpawnersProvider getSpawnersProvider()
​
return
SpawnersProvider
The current spawners provider instance.

​
setSpawnersProvider

Set custom spawners provider for the plugin. 
void setSpawnersProvider(SpawnersProvider spawnersProvider)
​
spawnersProvider
SpawnersProvider
The spawner provider to set.
Example: 
ProvidersManager manager = plugin.getProvidersManager();
manager.setSpawnersProvider(new CustomSpawnersProvider());

​
Stacked Blocks Provider

​
getStackedBlocksProvider

Get the currently used stacked-blocks provider. 
StackedBlocksProvider getStackedBlocksProvider()
​
return
StackedBlocksProvider
The current stacked-blocks provider instance.

​
setStackedBlocksProvider

Set a custom stacked-blocks provider for the plugin. 
void setStackedBlocksProvider(StackedBlocksProvider stackedBlocksProvider)
​
stackedBlocksProvider
StackedBlocksProvider
The stacked-blocks provider to set.
Example: 
manager.setStackedBlocksProvider(new CustomStackedBlocksProvider());

​
Entities Providers

​
getEntitiesProviders

Get the currently used stacked-entities providers. 
List<EntitiesProvider> getEntitiesProviders()
​
return
List<EntitiesProvider>
List of all registered entities providers.

​
addEntitiesProvider

Add a custom entities provider for the plugin. 
void addEntitiesProvider(EntitiesProvider entitiesProvider)
​
entitiesProvider
EntitiesProvider
The entities provider to add.
Example: 
manager.addEntitiesProvider(new CustomEntitiesProvider());

​
Economy Provider

​
getEconomyProvider

Get the currently used economy-provider. 
EconomyProvider getEconomyProvider()
​
return
EconomyProvider
The current economy provider instance.

​
setEconomyProvider

Set custom economy provider for the plugin. 
void setEconomyProvider(EconomyProvider economyProvider)
​
economyProvider
EconomyProvider
The economy provider to set.
Example: 
manager.setEconomyProvider(new CustomEconomyProvider());

​
Bank Economy Provider

​
getBankEconomyProvider

Get the currently used bank-economy provider. 
EconomyProvider getBankEconomyProvider()
​
return
EconomyProvider
The current bank economy provider instance.

​
setBankEconomyProvider

Set custom economy provider for the island banks. 
void setBankEconomyProvider(EconomyProvider economyProvider)
​
economyProvider
EconomyProvider
The economy provider to set.
Example: 
manager.setBankEconomyProvider(new CustomBankEconomyProvider());

​
Worlds Provider

​
getWorldsProvider

Get the currently used worlds-provider. 
WorldsProvider getWorldsProvider()
​
return
WorldsProvider
The current worlds provider instance.

​
setWorldsProvider

Set a custom worlds provider for the plugin. 
void setWorldsProvider(WorldsProvider worldsProvider)
​
worldsProvider
WorldsProvider
The worlds provider to set.
Example: 
manager.setWorldsProvider(new CustomWorldsProvider());

​
Chunks Provider

​
getChunksProvider

Get the currently used chunks-provider. 
ChunksProvider getChunksProvider()
​
return
ChunksProvider
The current chunks provider instance.

​
setChunksProvider

Set a custom chunks provider for the plugin. 
void setChunksProvider(ChunksProvider chunksProvider)
​
chunksProvider
ChunksProvider
The chunks provider to set.
Example: 
manager.setChunksProvider(new CustomChunksProvider());

​
AFK Providers

​
getAFKProviders

Get the currently used afk providers. 
List<AFKProvider> getAFKProviders()
​
return
List<AFKProvider>
List of all registered AFK providers.

​
addAFKProvider

Add AFK Provider to the plugin. 
void addAFKProvider(AFKProvider afkProvider)
​
afkProvider
AFKProvider
The afk-provider to add.
Example: 
manager.addAFKProvider(new CustomAFKProvider());

​
getMenusProvider

Get the currently used menus-provider. 
MenusProvider getMenusProvider()
​
return
MenusProvider
The current menus provider instance.

​
setMenusProvider

Set a new menus-provider to the plugin. 
void setMenusProvider(MenusProvider menuProvider)
​
menuProvider
MenusProvider
The new menus-provider to use.
Example: 
manager.setMenusProvider(new CustomMenusProvider());

​
Permissions Provider

​
getPermissionsProvider

Get the currently used permissions-provider. 
PermissionsProvider getPermissionsProvider()
​
return
PermissionsProvider
The current permissions provider instance.

​
setPermissionsProvider

Set a new permissions-provider to the plugin. 
void setPermissionsProvider(PermissionsProvider permissionsProvider)
​
permissionsProvider
PermissionsProvider
The new permissions-provider to use.
Example: 
manager.setPermissionsProvider(new CustomPermissionsProvider());

​
Prices Provider

​
getPricesProvider

Get the currently used prices-provider. 
PricesProvider getPricesProvider()
​
return
PricesProvider
The current prices provider instance.

​
setPricesProvider

Set a new prices-provider to the plugin. 
void setPricesProvider(PricesProvider pricesProvider)
​
pricesProvider
PricesProvider
The new prices-provider to use.
Example: 
manager.setPricesProvider(new CustomPricesProvider());

​
Vanish Provider

​
getVanishProvider

Get the currently used vanish-provider. 
VanishProvider getVanishProvider()
​
return
VanishProvider
The current vanish provider instance.

​
setVanishProvider

Set a new vanish-provider to the plugin. 
void setVanishProvider(VanishProvider vanishProvider)
​
vanishProvider
VanishProvider
The new vanish-provider to use.
Example: 
manager.setVanishProvider(new CustomVanishProvider());

​
Listener Registration

​
registerSkinsListener

Register a new skins listener. 
void registerSkinsListener(ISkinsListener skinsListener)
​
skinsListener
ISkinsListener
The new skins listener to register.
Example: 
manager.registerSkinsListener(new CustomSkinsListener());

​
unregisterSkinsListener

Unregister a skins listener. 
void unregisterSkinsListener(ISkinsListener skinsListener)
​
skinsListener
ISkinsListener
The skins listener to unregister.

​
registerStackedBlocksListener

Register a new stacked-blocks listener. 
void registerStackedBlocksListener(IStackedBlocksListener stackedBlocksListener)
​
stackedBlocksListener
IStackedBlocksListener
The new stacked-blocks listener to register.
Example: 
manager.registerStackedBlocksListener(new CustomStackedBlocksListener());

​
unregisterStackedBlocksListener

Unregister a stacked-blocks listener. 
void unregisterStackedBlocksListener(IStackedBlocksListener stackedBlocksListener)
​
stackedBlocksListener
IStackedBlocksListener
The stacked-blocks listener to unregister.

​
registerWorldsListener

Register a new worlds listener. 
void registerWorldsListener(IWorldsListener worldsListener)
​
worldsListener
IWorldsListener
The new worlds listener to register.
Example: 
manager.registerWorldsListener(new CustomWorldsListener());

​
unregisterWorldsListener

Unregister a worlds listener. 
void unregisterWorldsListener(IWorldsListener worldsListener)
​
worldsListener
IWorldsListener
The worlds listener to unregister.

Build docs developers (and LLMs) love

Get started for freeTalk to us