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

Class SlimefunGuide

java.lang.Object

io.github.thebusybiscuit.slimefun4.core.guide.SlimefunGuide

public final class SlimefunGuide
extends Object

This is a static utility class that provides convenient access to the methods of SlimefunGuideImplementation that abstracts away the actual implementation.

Author:

TheBusyBiscuit

See Also:

• SlimefunGuideImplementation
• SurvivalSlimefunGuide

Method Summary

Modifier and Type	Method	Description
static void	displayItem(PlayerProfile profile, SlimefunItem item, boolean addToHistory)
static void	displayItem(PlayerProfile profile, org.bukkit.inventory.ItemStack item, boolean addToHistory)
static SlimefunGuideMode	getDefaultMode()	Get the default mode for the Slimefun guide.
static org.bukkit.inventory.ItemStack	getItem(SlimefunGuideMode design)
static boolean	isGuideItem(org.bukkit.inventory.ItemStack item)	This method checks if a given ItemStack is a SlimefunGuide.
static void	openCheatMenu(org.bukkit.entity.Player p)
static void	openGuide(org.bukkit.entity.Player p, SlimefunGuideMode mode)
static void	openGuide(org.bukkit.entity.Player p, org.bukkit.inventory.ItemStack guide)
static void	openItemGroup(PlayerProfile profile, ItemGroup itemGroup, SlimefunGuideMode mode, int selectedPage)
static void	openMainMenu(PlayerProfile profile, SlimefunGuideMode mode, int selectedPage)
static void	openSearch(PlayerProfile profile, String input, SlimefunGuideMode mode, boolean addToHistory)

Methods inherited from class java.lang.Object

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

Method Details

getItem

@Nonnull
public static org.bukkit.inventory.ItemStack getItem(@Nonnull
 SlimefunGuideMode design)

openCheatMenu

public static void openCheatMenu(@Nonnull
 org.bukkit.entity.Player p)

openGuide

public static void openGuide(@Nonnull
 org.bukkit.entity.Player p,
 @Nullable
 org.bukkit.inventory.ItemStack guide)

openGuide

public static void openGuide(@Nonnull
 org.bukkit.entity.Player p,
 @Nonnull
 SlimefunGuideMode mode)

openMainMenu

@ParametersAreNonnullByDefault
public static void openMainMenu(PlayerProfile profile,
 SlimefunGuideMode mode,
 int selectedPage)

openItemGroup

@ParametersAreNonnullByDefault
public static void openItemGroup(PlayerProfile profile,
 ItemGroup itemGroup,
 SlimefunGuideMode mode,
 int selectedPage)

openSearch

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

displayItem

@ParametersAreNonnullByDefault
public static void displayItem(PlayerProfile profile,
 org.bukkit.inventory.ItemStack item,
 boolean addToHistory)

displayItem

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

isGuideItem

public static boolean isGuideItem(@Nullable
 org.bukkit.inventory.ItemStack item)

This method checks if a given ItemStack is a SlimefunGuide.

Parameters:

item - The ItemStack to check

Returns:

Whether this ItemStack represents a SlimefunGuide

getDefaultMode

@Nonnull
public static SlimefunGuideMode getDefaultMode()

Get the default mode for the Slimefun guide. Currently this is only SlimefunGuideMode.SURVIVAL_MODE.

Returns:

The default SlimefunGuideMode.