Package com.minecolonies.api.colony.buildings.modules

Interface IBuildingModuleView

All Known Subinterfaces:
IAssignmentModuleView, IEntityListModuleView, IItemListModuleView, IMinimumStockModuleView, ISettingsModuleView
All Known Implementing Classes:
AbstractBuildingModuleView, ArcherSquireModuleView, BuildingFarmer.FarmerFieldsModuleView, BuildingPlantation.PlantationFieldsModuleView, BuildingResourcesModuleView, BuildingStatisticsModuleView, ColonyConnectionModuleView, CombinedHiringLimitModuleView, CourierAssignmentModuleView, CourierRequestTaskModuleView, CrafterRequestTaskModuleView, CraftingModuleView, DOCraftingModuleView, EnchanterStationsModuleView, EntityListModuleView, ExpeditionLogModuleView, FieldsModuleView, FloristFlowerListModuleView, GraveyardManagementModuleView, ItemListModuleView, KnightSquireBuildingModuleView, LivingBuildingModuleView, MinerAssignmentModuleView, MinerGuardAssignModuleView, MinerLevelManagementModuleView, MinimumStockModuleView, PostBox.PostBoxMinimumStockModuleView, PupilBuildingModuleView, RequestTaskModuleView, RestaurantMenuModuleView, SettingsModuleView, StudentBuildingModuleView, ToolModuleView, TownHallSettingsModuleView, UniversityResearchModuleView, WarehouseOptionsModuleView, WarehouseRequestTaskModuleView, WorkerBuildingModuleView, WorkOrderListModuleView
public interface IBuildingModuleView
Default interface for all client side building modules.

  • Method Details

    • deserialize

      void deserialize(@NotNull @NotNull net.minecraft.network.FriendlyByteBuf buf)
      Deserialize the data on the client side.
      Parameters:
      buf - the buffer to read it from.

    • setBuildingView

      IBuildingModuleView setBuildingView(IBuildingView buildingView)
      Set the building view of this module view.
      Parameters:
      buildingView - the building view to set.
      Returns:
      this module itself.

    • isPageVisible

      default boolean isPageVisible()
      Whether this module appears as a GUI page.
      Returns:
      true to show the GUI page.

    • getWindow

      com.ldtteam.blockui.views.BOWindow getWindow()
      Get the matching window for the module.
      Returns:
      the window.

    • getIcon

      @Deprecated default String getIcon()
      Deprecated.
      Get the icon string for the module view.
      Returns:
      the icon identifier.

    • getIconResourceLocation

      default net.minecraft.resources.ResourceLocation getIconResourceLocation()
      Get the resource location of the icon for the module view.
      Returns:
      the resource location.

    • getDesc

      @Nullable @Nullable net.minecraft.network.chat.Component getDesc()
      Get the lang string for the title.
      Returns:
      the lang string.

    • setColonyView

      IBuildingModuleView setColonyView(IColonyView colonyView)

    • getColony

      IColonyView getColony()
      Get the colony view the module belongs to.
      Returns:
      the colony view.

    • getBuildingView

      IBuildingView getBuildingView()
      Get the building view to this.
      Returns:
      the building view.

    • setProducer

      <M extends IBuildingModule, V extends IBuildingModuleView> IBuildingModuleView setProducer(BuildingEntry.ModuleProducer<M,V> moduleSet)
      Set the producer of this module
      Parameters:
      moduleSet -
      Returns:

    • getProducer

      <M extends IBuildingModule, V extends IBuildingModuleView> BuildingEntry.ModuleProducer<M,V> getProducer()
      Get the producer of this module
      Returns: