All Implemented Interfaces:

io.github.pylonmc.rebar.item.interfaces.CooldownRebarItem , io.github.pylonmc.rebar.item.interfaces.InteractRebarItemHandler , net.kyori.adventure.key.Keyed , org.bukkit.Keyed
```
public final class RebarGuide
extends RebarItem implements InteractRebarItemHandler
                    
```
The one and only Rebar guide.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`RebarGuide.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`public final static NamespacedKey`	`KEY`
`public final static ItemStack`	`STACK`
`private final Map<UUID, List<GuidePage>>`	`history`
`private final Set<NamespacedKey>`	`hiddenItems`
`private final Set<NamespacedKey>`	`adminOnlyItems`
`private final Set<NamespacedKey>`	`hiddenFluids`
`private final Set<NamespacedKey>`	`hiddenResearches`
`private final Map<NamespacedKey, SimpleInfoPage>`	`infoPages`
`private final SimpleDynamicGuidePage`	`fluidsPage`
`private final PageButton`	`fluidsButton`
`private final HelpPage`	`helpPage`
`private final PageButton`	`helpButton`
`private final ResearchesPage`	`researchesPage`
`private final PageButton`	`researchesButton`
`private final RootPage`	`rootPage`
`private final BackButton`	`backButton`
`private final SearchItemsAndFluidsPage`	`searchItemsAndFluidsPage`
`private final PageButton`	`searchItemsAndFluidsButton`
`private final MainSettingsPage`	`mainSettingsPage`
`private final PageButton`	`mainSettingsButton`
`private final ItemStack`	`stack`
`private final RebarItemSchema`	`schema`
`private final RebarAddon`	`addon`
`private final NamespacedKey`	`rebarBlock`
`private final Boolean`	`isDisabled`
`private final Research`	`research`
`private final Boolean`	`respectCooldown`
`private final NamespacedKey`	`key`
`public final static RebarGuide.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
`RebarGuide(ItemStack stack)`

Method Summary

Modifier and Type	Method	Description
`void`	`onInteract(PlayerInteractEvent event, EventPriority priority)`	Called when a player clicks with the item in either main or off hand.
`final static AddonResearchesPage`	`addonResearchesPage(RebarAddon addon)`
`final static AddonPageButton`	`addonResearchesButton(RebarAddon addon)`
`final static ResearchItemsPage`	`researchItemsPage(Research research)`
`final static void`	`playGuideSound(Player $self, RandomizedSound sound, Sound.Emitter emitter)`
`final static void`	`playGuideSound(Player $self, RandomizedSound sound)`
`final static void`	`playGuideSound(Player $self, Sound sound, Sound.Emitter emitter)`
`final static void`	`playGuideSound(Player $self, Sound sound)`
`final static ItemIngredientsPage`	`ingredientsPage(FluidOrItem input)`
`final static PageButton`	`ingredientsButton(FluidOrItem input)`
`final static Item`	`infoButton(FluidOrItem input)`
`final static void`	`hideItem(NamespacedKey key)`	Hide an item from showing up in searches
`final static void`	`hideItemUnlessAdmin(NamespacedKey key)`	Hide an item from showing up in searches unless a player has the `rebar.guide.cheat` permission
`final static void`	`hideFluid(NamespacedKey key)`	Hide a fluid from showing up in searches
`final static void`	`hideResearch(NamespacedKey key)`	Hide a fluid from showing up in searches
`final static SimpleInfoPage`	`getOrCreateInfoPage(NamespacedKey key)`	Returns the info page menu for an item or fluid.
`final static SimpleInfoPage`	`getInfoPage(NamespacedKey key)`	Returns the info page menu for an item or fluid.
`final static void`	`open(Player player)`	Opens the guide to the last page that the player was on
`final static Map<UUID, List<GuidePage>>`	`getHistory()`	Keeps track of the pages the player last visited Resets when the player ends up on the root page
`final static Set<NamespacedKey>`	`getHiddenItems()`	Hidden items do not show up in searches
`final static Set<NamespacedKey>`	`getAdminOnlyItems()`	Admin items do not show up in searches unless a player has the `rebar.guide.cheat` permission
`final static Set<NamespacedKey>`	`getHiddenFluids()`	Hidden fluids do not show up in searches
`final static Set<NamespacedKey>`	`getHiddenResearches()`	Hidden researches do not show up in the researches category
`final static Map<NamespacedKey, SimpleInfoPage>`	`getInfoPages()`
`final static SimpleDynamicGuidePage`	`getFluidsPage()`
`final static PageButton`	`getFluidsButton()`
`final static HelpPage`	`getHelpPage()`
`final static PageButton`	`getHelpButton()`
`final static ResearchesPage`	`getResearchesPage()`
`final static PageButton`	`getResearchesButton()`
`final static RootPage`	`getRootPage()`
`final static BackButton`	`getBackButton()`
`final static SearchItemsAndFluidsPage`	`getSearchItemsAndFluidsPage()`
`final static PageButton`	`getSearchItemsAndFluidsButton()`
`final static MainSettingsPage`	`getMainSettingsPage()`
`final static PageButton`	`getMainSettingsButton()`
`final static Boolean`	`getGuideHints(Player $self)`
`final static void`	`setGuideHints(Player $self, Boolean <set-?>)`
`final static Boolean`	`getGuideSounds(Player $self)`
`final static void`	`setGuideSounds(Player $self, Boolean <set-?>)`

Methods inherited from class io.github.pylonmc.rebar.item.RebarItem
equals, getAddon, getKey, getKey, getPlaceholders, getRebarBlock, getResearch, getSchema, getSetting, getSetting, getSetting, getSettingOrThrow, getSettings, getStack, hashCode, isDisabled, place, prePlace
Methods inherited from class io.github.pylonmc.rebar.item.interfaces.CooldownRebarItem
hasCooldown, respectCooldown
Methods inherited from class org.bukkit.Keyed
key
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- RebarGuide
```
RebarGuide(ItemStack stack)
```

Method Detail

onInteract
```
 void onInteract(PlayerInteractEvent event, EventPriority priority)
```
Called when a player clicks with the item in either main or off hand.

addonResearchesPage

 final static AddonResearchesPage addonResearchesPage(RebarAddon addon)

addonResearchesButton

 final static AddonPageButton addonResearchesButton(RebarAddon addon)

researchItemsPage

 final static ResearchItemsPage researchItemsPage(Research research)

playGuideSound

@JvmOverloads() final static void playGuideSound(Player $self, RandomizedSound sound, Sound.Emitter emitter)

playGuideSound

@JvmOverloads() final static void playGuideSound(Player $self, RandomizedSound sound)

playGuideSound

@JvmOverloads() final static void playGuideSound(Player $self, Sound sound, Sound.Emitter emitter)

playGuideSound

@JvmOverloads() final static void playGuideSound(Player $self, Sound sound)

ingredientsPage

 final static ItemIngredientsPage ingredientsPage(FluidOrItem input)

ingredientsButton

 final static PageButton ingredientsButton(FluidOrItem input)

infoButton

 final static Item infoButton(FluidOrItem input)

hideItem

 final static void hideItem(NamespacedKey key)

Hide an item from showing up in searches

hideItemUnlessAdmin
```
 final static void hideItemUnlessAdmin(NamespacedKey key)
```
Hide an item from showing up in searches unless a player has the rebar.guide.cheat permission

hideFluid

 final static void hideFluid(NamespacedKey key)

Hide a fluid from showing up in searches

hideResearch

 final static void hideResearch(NamespacedKey key)

Hide a fluid from showing up in searches

getOrCreateInfoPage
```
 final static SimpleInfoPage getOrCreateInfoPage(NamespacedKey key)
```
Returns the info page menu for an item or fluid. If no info page exists for the item already, a new one will be created when this function is called.

getInfoPage

 final static SimpleInfoPage getInfoPage(NamespacedKey key)

Returns the info page menu for an item or fluid.

open
```
 final static void open(Player player)
```
Opens the guide to the last page that the player was on

getHistory
```
 final static Map<UUID, List<GuidePage>> getHistory()
```
Keeps track of the pages the player last visited Resets when the player ends up on the root page

getHiddenItems
```
 final static Set<NamespacedKey> getHiddenItems()
```
Hidden items do not show up in searches

getAdminOnlyItems
```
 final static Set<NamespacedKey> getAdminOnlyItems()
```
Admin items do not show up in searches unless a player has the rebar.guide.cheat permission

getHiddenFluids
```
 final static Set<NamespacedKey> getHiddenFluids()
```
Hidden fluids do not show up in searches

getHiddenResearches
```
 final static Set<NamespacedKey> getHiddenResearches()
```
Hidden researches do not show up in the researches category

getInfoPages

 final static Map<NamespacedKey, SimpleInfoPage> getInfoPages()

getFluidsPage

 final static SimpleDynamicGuidePage getFluidsPage()

getFluidsButton

 final static PageButton getFluidsButton()

getHelpPage
```
 final static HelpPage getHelpPage()
```

getHelpButton

 final static PageButton getHelpButton()

getResearchesPage

 final static ResearchesPage getResearchesPage()

getResearchesButton

 final static PageButton getResearchesButton()

getRootPage
```
 final static RootPage getRootPage()
```

getBackButton

 final static BackButton getBackButton()

getSearchItemsAndFluidsPage

 final static SearchItemsAndFluidsPage getSearchItemsAndFluidsPage()

getSearchItemsAndFluidsButton

 final static PageButton getSearchItemsAndFluidsButton()

getMainSettingsPage

 final static MainSettingsPage getMainSettingsPage()

getMainSettingsButton

 final static PageButton getMainSettingsButton()

getGuideHints

 final static Boolean getGuideHints(Player $self)

setGuideHints

 final static void setGuideHints(Player $self, Boolean <set-?>)

getGuideSounds

 final static Boolean getGuideSounds(Player $self)

setGuideSounds

 final static void setGuideSounds(Player $self, Boolean <set-?>)

Class RebarGuide

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class io.github.pylonmc.rebar.item.RebarItem

Methods inherited from class io.github.pylonmc.rebar.item.interfaces.CooldownRebarItem

Methods inherited from class org.bukkit.Keyed

Methods inherited from class java.lang.Object

Constructor Detail

RebarGuide

Method Detail

onInteract

addonResearchesPage

addonResearchesButton

researchItemsPage

playGuideSound

playGuideSound

playGuideSound

playGuideSound

ingredientsPage

ingredientsButton

infoButton

hideItem

hideItemUnlessAdmin

hideFluid

hideResearch

getOrCreateInfoPage

getInfoPage

open

getHistory

getHiddenItems

getAdminOnlyItems

getHiddenFluids

getHiddenResearches

getInfoPages

getFluidsPage

getFluidsButton

getHelpPage

getHelpButton

getResearchesPage

getResearchesButton

getRootPage

getBackButton

getSearchItemsAndFluidsPage

getSearchItemsAndFluidsButton

getMainSettingsPage

getMainSettingsButton

getGuideHints

setGuideHints

getGuideSounds

setGuideSounds