Package com.minecolonies.api.research

Interface IGlobalResearchBranch

All Known Implementing Classes:
GlobalResearchBranch
public interface IGlobalResearchBranch

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getBaseTime(int depth)
    Get the base progress requirements for non-instant research on the branch.
    boolean
    getHidden()
    Get if the branch should be hidden, even from the selection list, until at least one research is eligible to begin.
    double
    getHoursTime(int depth)
    Get the base progress time requirements for non-instant research on the branch.
    net.minecraft.network.chat.contents.TranslatableContents
    getName()
    Get the human-readable name or translation key for the Research Branch
    int
    getSortOrder()
    Get the sort order numeral for the branch's placement on the University Hut GUI.
    net.minecraft.network.chat.contents.TranslatableContents
    getSubtitle()
    Get the optional human-readable subtitle or its translation key for the Research Branch
    ResearchBranchType
    getType()
    Get the branch style type identifier.
    net.minecraft.nbt.CompoundTag
    writeToNBT()
    Write the Branch characteristics to an NBT for serialization.

  • Method Details

    • getName

      net.minecraft.network.chat.contents.TranslatableContents getName()
      Get the human-readable name or translation key for the Research Branch
      Returns:
      Human-readable name or translation key.

    • getSubtitle

      net.minecraft.network.chat.contents.TranslatableContents getSubtitle()
      Get the optional human-readable subtitle or its translation key for the Research Branch
      Returns:
      Human-readable subtitle or translation key.

    • getBaseTime

      int getBaseTime(int depth)
      Get the base progress requirements for non-instant research on the branch.
      Parameters:
      depth - The university level for the research.
      Returns:
      The number of progress 'ticks' required to complete the research for the included depth. Each tick is (on average) 25 seconds, but this depends on researcher availability and may be reduced by stored researcher time.

    • getHoursTime

      double getHoursTime(int depth)
      Get the base progress time requirements for non-instant research on the branch. Use only for direct display purposes, as it is likely to be inaccurate. Favor getBaseTime for any mathematical use.
      Parameters:
      depth - The university level for the research.
      Returns:
      The number of hours required to complete a research for the included depth, to a rough estimate.

    • getSortOrder

      int getSortOrder()
      Get the sort order numeral for the branch's placement on the University Hut GUI.
      Returns:
      The sort order.

    • getType

      ResearchBranchType getType()
      Get the branch style type identifier.
      Returns:
      the branch's style, used for logic and presentation.

    • getHidden

      boolean getHidden()
      Get if the branch should be hidden, even from the selection list, until at least one research is eligible to begin.
      Returns:
      True if the branch shouldn't be visible until at least one research may begin.

    • writeToNBT

      net.minecraft.nbt.CompoundTag writeToNBT()
      Write the Branch characteristics to an NBT for serialization.
      Returns:
      a compoundNBT containing the necessary traits to make the branch data on a client.