Package com.minecolonies.api.research

Interface IResearchRequirement

All Known Implementing Classes:
BuildingAlternatesResearchRequirement, BuildingResearchRequirement, ResearchResearchRequirement
public interface IResearchRequirement
Interface of research requirements.

  • Method Details

    • getRegistryEntry

      ModResearchRequirements.ResearchRequirementEntry getRegistryEntry()
      Get the ModResearchRequirements.ResearchRequirementEntry for this Research Requirement.
      Returns:
      a registry entry.

    • getDesc

      net.minecraft.network.chat.MutableComponent getDesc()
      Get a human-readable description of the requirement, or a translation key.
      Returns:
      translation text component.

    • isFulfilled

      boolean isFulfilled(IColony colony)
      Check if this requirement is fulfilled for a certain colony.
      Parameters:
      colony - the colony to check.
      Returns:
      true if so.

    • writeToNBT

      net.minecraft.nbt.CompoundTag writeToNBT()
      Write the ResearchRequirement's traits to NBT, to simplify serialization for client-viewable data.
      Returns:
      an NBT file which must, at minimum, contain the necessary traits to reassemble the effect.