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 MenusManager handles opening, refreshing, and destroying GUI menus for players. It provides methods to access all built-in menus and allows registration of custom menus.

​
Opening Menus

​
Bank and Logs

void openBankLogs(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland)
void refreshBankLogs(Island island)

void openIslandBank(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland)
void refreshIslandBank(Island island)

​
Biomes and Border

void openBiomes(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland)
void openBorderColor(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu)

​
Confirmation Menus

void openConfirmBan(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland, SuperiorPlayer bannedPlayer)
void openConfirmDisband(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland)
void openConfirmKick(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland, SuperiorPlayer kickedPlayer)
void openConfirmLeave(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu)
void openConfirmTransfer(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland, SuperiorPlayer newOwner)

​
Island Management

void openControlPanel(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland)
void openIslandCreation(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, String islandName)
void openSettings(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland)
void refreshSettings(Island island)

​
Members and Permissions

void openMembers(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland)
void refreshMembers(Island island)

void openMemberManage(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, SuperiorPlayer islandMember)
void destroyMemberManage(SuperiorPlayer islandMember)

void openMemberRole(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, SuperiorPlayer islandMember)
void destroyMemberRole(SuperiorPlayer islandMember)

void openCoops(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland)
void refreshCoops(Island island)

void openIslandBannedPlayers(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland)
void refreshIslandBannedPlayers(Island island)

​
Permissions

void openPermissions(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland, SuperiorPlayer permissiblePlayer)
void openPermissions(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland, PlayerRole permissibleRole)
void refreshPermissions(Island island)
void refreshPermissions(Island island, SuperiorPlayer permissiblePlayer)
void refreshPermissions(Island island, PlayerRole permissibleRole)
void updatePermission(IslandPrivilege islandPrivilege)

​
Missions

void openMissions(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu)
void openMissionsCategory(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, MissionCategory missionCategory)
void refreshMissionsCategory(MissionCategory missionCategory)

​
Warps

void openGlobalWarps(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu)
void refreshGlobalWarps()

void openWarpCategories(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland)
void refreshWarpCategories(Island island)
void destroyWarpCategories(Island island)

void openWarps(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, WarpCategory targetCategory)
void refreshWarps(WarpCategory warpCategory)
void destroyWarps(WarpCategory warpCategory)

void openWarpManage(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, IslandWarp targetWarp)
void refreshWarpManage(IslandWarp islandWarp)
void openWarpIconEdit(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, IslandWarp targetWarp)

void openWarpCategoryManage(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, WarpCategory targetCategory)
void refreshWarpCategoryManage(WarpCategory warpCategory)
void openWarpCategoryIconEdit(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, WarpCategory targetCategory)

​
Island Information

void openCounts(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland)
void refreshCounts(Island island)

void openValues(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland)
void refreshValues(Island island)

void openIslandChest(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland)
void refreshIslandChest(Island island)

​
Ratings and Visitors

void openIslandRate(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland)
void openIslandRatings(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland)
void refreshIslandRatings(Island island)

void openVisitors(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland)
void refreshVisitors(Island island)

void openUniqueVisitors(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland)
void refreshUniqueVisitors(Island island)

​
Top Islands and Upgrades

void openTopIslands(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, SortingType sortingType)
void refreshTopIslands(SortingType sortingType)

void openUpgrades(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu, Island targetIsland)
void refreshUpgrades(Island island)

​
Other Menus

void openPlayerLanguage(SuperiorPlayer targetPlayer, @Nullable ISuperiorMenu previousMenu)

​
Custom Menu Registration

​
registerMenu

void registerMenu(Menu<?, ?> menu)
Register a new menu to the plugin.
​
menu
Menu<?, ?>
required
The menu to register

​
getMenu

<V extends MenuView<V, A>, A extends ViewArgs> Menu<V, A> getMenu(String identifier)
Get a menu by its identifier.
​
identifier
String
required
The identifier of the menu
​
return
Menu<V, A>
The menu instance or null if not found

​
getMenus

Map<String, Menu<?, ?>> getMenus()
Get all the registered menus.
​
return
Map<String, Menu<?, ?>>
Map of all registered menus

​
getCustomMenus

Map<String, Menu<?, ?>> getCustomMenus()
Get all the custom menus that were registered.
​
return
Map<String, Menu<?, ?>>
Map of all custom menus

​
createPatternBuilder

<V extends MenuView<V, ?>> MenuLayout.Builder<V> createPatternBuilder()
Create a new pattern builder for building a menu.
​
return
MenuLayout.Builder<V>
New menu layout builder

​
createPagedPatternBuilder

<V extends PagedMenuView<V, ?, E>, E> PagedMenuLayout.Builder<V, E> createPagedPatternBuilder()
Create a new pattern builder for building a paged-based menu.
​
return
PagedMenuLayout.Builder<V, E>
New paged menu layout builder

​
createButtonBuilder

<V extends MenuView<V, ?>> MenuTemplateButton.Builder<V> createButtonBuilder(Class<?> viewButtonType, MenuTemplateButton.MenuViewButtonCreator<V> viewButtonCreator)
Create a new button builder.

​
createPagedButtonBuilder

<V extends MenuView<V, ?>, E> PagedMenuTemplateButton.Builder<V, E> createPagedButtonBuilder(Class<?> viewButtonType, PagedMenuTemplateButton.PagedMenuViewButtonCreator<V, E> viewButtonCreator)
Create a new paged button builder.

​
Utilities

​
getParser

MenuParser getParser()
Get the parser instance.
​
return
MenuParser
The menu parser instance

​
getMenuCommands

MenuCommands getMenuCommands()
Get the commands executor instance.
​
return
MenuCommands
The menu commands instance

​
Common Parameters

​
targetPlayer
SuperiorPlayer
The player to open the menu for
​
previousMenu
ISuperiorMenu
The previous menu that was opened, if exists (nullable)
​
targetIsland
Island
The island associated with the menu

Build docs developers (and LLMs) love

Get started for freeTalk to us