Package io.github.thebusybiscuit.slimefun4.implementation.guide

Class SurvivalSlimefunGuide

java.lang.Object

io.github.thebusybiscuit.slimefun4.implementation.guide.SurvivalSlimefunGuide

All Implemented Interfaces:

SlimefunGuideImplementation

Direct Known Subclasses:

CheatSheetSlimefunGuide

public class SurvivalSlimefunGuide
extends Object
implements SlimefunGuideImplementation

The SurvivalSlimefunGuide is the standard version of our SlimefunGuide. It uses an Inventory to display SlimefunGuide contents.

Author:

TheBusyBiscuit

See Also:

• SlimefunGuide
• SlimefunGuideImplementation
• CheatSheetSlimefunGuide

Constructor Summary

Constructors

Constructor	Description
SurvivalSlimefunGuide(boolean showVanillaRecipes, boolean showHiddenItemGroupsInSearch)

Method Summary

Modifier and Type	Method	Description
void	createHeader(Player p, PlayerProfile profile, ChestMenu menu)
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.
protected List<ItemGroup>	getVisibleItemGroups(Player p, PlayerProfile profile)	Returns a List of visible ItemGroup instances that the SlimefunGuide would display.
protected final boolean	isSurvivalMode()
void	openItemGroup(PlayerProfile profile, ItemGroup itemGroup, int page)
void	openMainMenu(PlayerProfile profile, int page)
void	openSearch(PlayerProfile profile, String input, boolean addToHistory)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.thebusybiscuit.slimefun4.core.guide.SlimefunGuideImplementation

unlockItem

Constructor Details

SurvivalSlimefunGuide

public SurvivalSlimefunGuide(boolean showVanillaRecipes,
 boolean showHiddenItemGroupsInSearch)

Method Details

getMode

@Nonnull
public SlimefunGuideMode getMode()

Description copied from interface: SlimefunGuideImplementation

Every SlimefunGuideImplementation can be associated with a SlimefunGuideMode.

Specified by:

getMode in interface SlimefunGuideImplementation

Returns:

The mode this SlimefunGuideImplementation represents

getItem

@Nonnull
public ItemStack getItem()

Description copied from interface: SlimefunGuideImplementation

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

Specified by:

getItem in interface SlimefunGuideImplementation

Returns:

The ItemStack representation for this SlimefunGuideImplementation

isSurvivalMode

protected final boolean isSurvivalMode()

getVisibleItemGroups

@Nonnull
protected List<ItemGroup> getVisibleItemGroups(@Nonnull
 Player p,
 @Nonnull
 PlayerProfile profile)

Returns a List of visible ItemGroup instances that the SlimefunGuide would display.

Parameters:

p - The Player who opened his SlimefunGuide

profile - The PlayerProfile of the Player

Returns:

a List of visible ItemGroup instances

openMainMenu

public void openMainMenu(PlayerProfile profile,
 int page)

Specified by:

openMainMenu in interface SlimefunGuideImplementation

openItemGroup

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

Specified by:

openItemGroup in interface SlimefunGuideImplementation

openSearch

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

Specified by:

openSearch in interface SlimefunGuideImplementation

displayItem

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

Specified by:

displayItem in interface SlimefunGuideImplementation

displayItem

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

Specified by:

displayItem in interface SlimefunGuideImplementation

createHeader

@ParametersAreNonnullByDefault
public void createHeader(Player p,
 PlayerProfile profile,
 ChestMenu menu)