Constructor Detail

• Research

  Research(NamespacedKey key, ItemStack itemTemplate, Component name, Long cost, Set<NamespacedKey> unlocks)

• Research

  Research(NamespacedKey key, ItemStack item, Long cost, NamespacedKey unlocks)

  A constructor that sets the name to a default language file key.

Method Detail

• getName

   final Component getName()

• getCost

   final Long getCost()

  If null, the research cannot be unlocked using points

• getUnlocks

   final Set<NamespacedKey> getUnlocks()

  The keys of the items that are unlocked by this research

• getItem

   final ItemStack getItem()

• register

   final void register()

• addTo

  @JvmOverloads() final void addTo(Player player, Boolean sendMessage, Boolean effects)

  Adds the research to a player.

  Parameters:

  sendMessage - If set, sends a message to notify the player that they have unlocked the research

• addTo

  @JvmOverloads() final void addTo(Player player, Boolean sendMessage)

  Adds the research to a player.

  Parameters:

  sendMessage - If set, sends a message to notify the player that they have unlocked the research

• addTo

  @JvmOverloads() final void addTo(Player player)

  Adds the research to a player.

• removeFrom

   final void removeFrom(Player player)

  Removes a research from a player.

• isResearchedBy

   final Boolean isResearchedBy(Player player)

  Returns whether a research has been researched by the given player.

• getKey

   NamespacedKey getKey()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• getResearches

   final static Set<Research> getResearches(OfflinePlayer player)

• setResearches

   final static void setResearches(Player player, Set<Research> researches)

• addResearch

   final static void addResearch(Player player, Research research)

• removeResearch

   final static void removeResearch(Player player, Research research)

• canPlayerCraft

  @JvmOverloads() final static Boolean canPlayerCraft(Player $self, RebarItem item, Boolean sendMessage, Boolean respectBypass)

• canPlayerCraft

  @JvmOverloads() final static Boolean canPlayerCraft(Player $self, RebarItem item, Boolean sendMessage)

• canPlayerCraft

  @JvmOverloads() final static Boolean canPlayerCraft(Player $self, RebarItem item)

• canPlayerCraft

  @JvmOverloads() final static Boolean canPlayerCraft(Player $self, RebarItemSchema schema, Boolean sendMessage, Boolean respectBypass)

  Checks whether a player can craft an item (ie has the associated research, or has permission to bypass research.

  Parameters:

  sendMessage - Whether, if the player cannot craft the item, a message should be sent to them to notify them of this fact

• canPlayerCraft

  @JvmOverloads() final static Boolean canPlayerCraft(Player $self, RebarItemSchema schema, Boolean sendMessage)

  Checks whether a player can craft an item (ie has the associated research, or has permission to bypass research.

  Parameters:

  sendMessage - Whether, if the player cannot craft the item, a message should be sent to them to notify them of this fact

• canPlayerCraft

  @JvmOverloads() final static Boolean canPlayerCraft(Player $self, RebarItemSchema schema)

  Checks whether a player can craft an item (ie has the associated research, or has permission to bypass research.

• canPlayerPickUp

  @JvmOverloads() final static Boolean canPlayerPickUp(Player $self, RebarItem item, Boolean sendMessage)

  Checks whether a player can pick up an item (ie has the associated research, or has permission to bypass research.

  Parameters:

  sendMessage - Whether, if the player cannot pick up the item, a message should be sent to them to notify them of this fact

• canPlayerPickUp

  @JvmOverloads() final static Boolean canPlayerPickUp(Player $self, RebarItem item)

  Checks whether a player can pick up an item (ie has the associated research, or has permission to bypass research.

• canPlayerUse

  @JvmOverloads() final static Boolean canPlayerUse(Player $self, RebarItem item, Boolean sendMessage)

• canPlayerUse

  @JvmOverloads() final static Boolean canPlayerUse(Player $self, RebarItem item)

• canPlayerUse

  @JvmOverloads() final static Boolean canPlayerUse(Player $self, RebarItemSchema schema, Boolean sendMessage)

  Checks whether a player can use an item (ie has the associated research, or has permission to bypass research.

  Parameters:

  sendMessage - Whether, if the player cannot use the item, a message should be sent to them to notify them of this fact

• canPlayerUse

  @JvmOverloads() final static Boolean canPlayerUse(Player $self, RebarItemSchema schema)

  Checks whether a player can use an item (ie has the associated research, or has permission to bypass research.

• loadFromConfig

   final static Research loadFromConfig(ConfigSection section, NamespacedKey key)

• getResearchPoints

   final static Long getResearchPoints(Player $self)

• setResearchPoints

   final static void setResearchPoints(Player $self, Long <set-?>)

• getResearchConfetti

   final static Boolean getResearchConfetti(Player $self)

• setResearchConfetti

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

• getResearchSounds

   final static Boolean getResearchSounds(Player $self)

• setResearchSounds

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

• getGuideHints

   final static Boolean getGuideHints(Player $self)

• setGuideHints

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