Package io.github.thebusybiscuit.slimefun4.core.guide

Interface SlimefunGuideImplementation

All Known Implementing Classes:

CheatSheetSlimefunGuide, SurvivalSlimefunGuide

public interface SlimefunGuideImplementation

This interface is used for the different implementations that add behaviour to the SlimefunGuide.

Author:

TheBusyBiscuit

See Also:

• SlimefunGuideMode
• SurvivalSlimefunGuide

Method Summary

Modifier and Type	Method	Description
void	displayItem(PlayerProfile profile, SlimefunItem item, boolean addToHistory)
void	displayItem(PlayerProfile profile, ItemStack item, int index, boolean addToHistory)
ItemStack	getItem()	Returns the ItemStack representation for this SlimefunGuideImplementation.
SlimefunGuideMode	getMode()	Every SlimefunGuideImplementation can be associated with a SlimefunGuideMode.
void	openItemGroup(PlayerProfile profile, ItemGroup group, int page)
void	openMainMenu(PlayerProfile profile, int page)
void	openSearch(PlayerProfile profile, String input, boolean addToHistory)
default void	unlockItem(Player p, SlimefunItem sfitem, Consumer<Player> callback)

Method Details

getMode

@Nonnull
SlimefunGuideMode getMode()

Every SlimefunGuideImplementation can be associated with a SlimefunGuideMode.

Returns:

The mode this SlimefunGuideImplementation represents

getItem

@Nonnull
ItemStack getItem()

Returns the ItemStack representation for this SlimefunGuideImplementation. In other words: The ItemStack you hold in your hand and that you use to open your SlimefunGuide

Returns:

The ItemStack representation for this SlimefunGuideImplementation

openMainMenu

@ParametersAreNonnullByDefault
void openMainMenu(PlayerProfile profile,
 int page)

openItemGroup

@ParametersAreNonnullByDefault
void openItemGroup(PlayerProfile profile,
 ItemGroup group,
 int page)

openSearch

@ParametersAreNonnullByDefault
void openSearch(PlayerProfile profile,
 String input,
 boolean addToHistory)

displayItem

@ParametersAreNonnullByDefault
void displayItem(PlayerProfile profile,
 ItemStack item,
 int index,
 boolean addToHistory)

displayItem

@ParametersAreNonnullByDefault
void displayItem(PlayerProfile profile,
 SlimefunItem item,
 boolean addToHistory)

unlockItem

@ParametersAreNonnullByDefault
default void unlockItem(Player p,
 SlimefunItem sfitem,
 Consumer<Player> callback)