Package com.minecolonies.core.colony

Class ColonyView

java.lang.Object
com.minecolonies.core.colony.ColonyView
All Implemented Interfaces:
IColony, IColonyView
public final class ColonyView extends Object implements IColonyView
Client side representation of the Colony.

  • Method Details

    • createFromNetwork

      @NotNull public static @NotNull ColonyView createFromNetwork(int id)
      Create a ColonyView given a UUID and CompoundTag.
      Parameters:
      id - Id of the colony view.
      Returns:
      the new colony view.

    • serializeNetworkData

      public static void serializeNetworkData(@NotNull @NotNull Colony colony, @NotNull @NotNull net.minecraft.network.FriendlyByteBuf buf, boolean hasNewSubscribers)
      Populate an NBT compound for a network packet representing a ColonyView.
      Parameters:
      colony - Colony to write data about.
      buf - FriendlyByteBuf to write data in.
      hasNewSubscribers - true if there is a new subscription.

    • getFreePositions

      public List<net.minecraft.core.BlockPos> getFreePositions()
      Get a copy of the freePositions list.
      Specified by:
      getFreePositions in interface IColonyView
      Returns:
      the list of free to interact positions.

    • getFreeBlocks

      public List<net.minecraft.world.level.block.Block> getFreeBlocks()
      Get a copy of the freeBlocks list.
      Specified by:
      getFreeBlocks in interface IColonyView
      Returns:
      the list of free to interact blocks.

    • addFreePosition

      public void addFreePosition(@NotNull @NotNull net.minecraft.core.BlockPos pos)
      Add a new free to interact position.
      Specified by:
      addFreePosition in interface IColony
      Specified by:
      addFreePosition in interface IColonyView
      Parameters:
      pos - position to add.

    • addFreeBlock

      public void addFreeBlock(@NotNull @NotNull net.minecraft.world.level.block.Block block)
      Add a new free to interact block.
      Specified by:
      addFreeBlock in interface IColony
      Specified by:
      addFreeBlock in interface IColonyView
      Parameters:
      block - block to add.

    • removeFreePosition

      public void removeFreePosition(@NotNull @NotNull net.minecraft.core.BlockPos pos)
      Remove a free to interact position.
      Specified by:
      removeFreePosition in interface IColony
      Specified by:
      removeFreePosition in interface IColonyView
      Parameters:
      pos - position to remove.

    • removeFreeBlock

      public void removeFreeBlock(@NotNull @NotNull net.minecraft.world.level.block.Block block)
      Remove a free to interact block.
      Specified by:
      removeFreeBlock in interface IColony
      Specified by:
      removeFreeBlock in interface IColonyView
      Parameters:
      block - state to remove.

    • setCanBeAutoDeleted

      public void setCanBeAutoDeleted(boolean canBeDeleted)
      Specified by:
      setCanBeAutoDeleted in interface IColony

    • getDimension

      public net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> getDimension()
      Returns the dimension ID of the view.
      Specified by:
      getDimension in interface IColony
      Specified by:
      getDimension in interface IColonyView
      Returns:
      dimension ID of the view.

    • write

      public net.minecraft.nbt.CompoundTag write(net.minecraft.nbt.CompoundTag colonyCompound)
      Specified by:
      write in interface IColony

    • read

      public void read(net.minecraft.nbt.CompoundTag compound)
      Specified by:
      read in interface IColony

    • addWayPoint

      public void addWayPoint(net.minecraft.core.BlockPos pos, net.minecraft.world.level.block.state.BlockState newWayPointState)
      Specified by:
      addWayPoint in interface IColony

    • isValidAttackingGuard

      public boolean isValidAttackingGuard(AbstractEntityCitizen entity)
      Specified by:
      isValidAttackingGuard in interface IColony

    • useAdditionalChildTime

      public boolean useAdditionalChildTime(int amount)
      Tries to use a given amount of additional growth-time for childs.
      Specified by:
      useAdditionalChildTime in interface IColony
      Parameters:
      amount - amount to use
      Returns:
      true if used up.

    • updateHasChilds

      public void updateHasChilds()
      Description copied from interface: IColony
      Sets whether the colony has a child.
      Specified by:
      updateHasChilds in interface IColony

    • addLoadedChunk

      public void addLoadedChunk(long chunkPos, net.minecraft.world.level.chunk.LevelChunk chunk)
      Description copied from interface: IColony
      Adds a loaded chunk to the colony list
      Specified by:
      addLoadedChunk in interface IColony
      Parameters:
      chunkPos - chunk to add

    • removeLoadedChunk

      public void removeLoadedChunk(long chunkPos)
      Description copied from interface: IColony
      Adds a chunk from the colony list
      Specified by:
      removeLoadedChunk in interface IColony
      Parameters:
      chunkPos - chunk to remove

    • getLoadedChunkCount

      public int getLoadedChunkCount()
      Description copied from interface: IColony
      Returns the amount of loaded chunks
      Specified by:
      getLoadedChunkCount in interface IColony
      Returns:
      amount of chunks

    • getLoadedChunks

      public Set<Long> getLoadedChunks()
      Specified by:
      getLoadedChunks in interface IColony

    • getState

      public ColonyState getState()
      Description copied from interface: IColony
      Returns the colonies current state.
      Specified by:
      getState in interface IColony
      Returns:
      the state.

    • isActive

      public boolean isActive()
      Description copied from interface: IColony
      Is the colony active currently.
      Specified by:
      isActive in interface IColony
      Returns:
      true if so.

    • getTicketedChunks

      public Set<Long> getTicketedChunks()
      Description copied from interface: IColony
      Get the set of chunk positions which the colony is loading through tickets
      Specified by:
      getTicketedChunks in interface IColony
      Returns:
      set of positions

    • setTextureStyle

      public void setTextureStyle(String style)
      Description copied from interface: IColony
      Set the texture style of the colony.
      Specified by:
      setTextureStyle in interface IColony
      Parameters:
      style - the style to set.

    • getTextureStyleId

      public String getTextureStyleId()
      Description copied from interface: IColony
      Get the colony style.
      Specified by:
      getTextureStyleId in interface IColony
      Returns:
      the string id of the style.

    • getPlayers

      @NotNull public @NotNull Map<UUID,ColonyPlayer> getPlayers()
      Returns a map of players in the colony. Key is the UUID, value is ColonyPlayer
      Specified by:
      getPlayers in interface IColonyView
      Returns:
      Map of UUID's and ColonyPlayer

    • getCitizenCount

      public int getCitizenCount()
      Returns the maximum amount of citizen in the colony.
      Specified by:
      getCitizenCount in interface IColonyView
      Returns:
      maximum amount of citizens.

    • getCitizenCountLimit

      public int getCitizenCountLimit()
      Description copied from interface: IColonyView
      Returns the maximum amount of citizen slots in the colony considering beds and guard towers
      Specified by:
      getCitizenCountLimit in interface IColonyView
      Returns:
      maximum amount of citizens.

    • getCitizens

      public Map<Integer,ICitizenDataView> getCitizens()
      Getter for the citizens map.
      Specified by:
      getCitizens in interface IColonyView
      Returns:
      a unmodifiable Map of the citizen.

    • getWorkOrders

      public Collection<IWorkOrderView> getWorkOrders()
      Getter for the workOrders.
      Specified by:
      getWorkOrders in interface IColonyView
      Returns:
      a unmodifiable Collection of the workOrders.

    • getWorkOrder

      public IWorkOrderView getWorkOrder(int id)
      Description copied from interface: IColonyView
      Getter for a single workorder.
      Specified by:
      getWorkOrder in interface IColonyView
      Parameters:
      id - workorder id.
      Returns:
      a specific workorder.

    • getCitizen

      public ICitizenDataView getCitizen(int id)
      Gets the CitizenDataView for a citizen id.
      Specified by:
      getCitizen in interface IColony
      Specified by:
      getCitizen in interface IColonyView
      Parameters:
      id - the citizen id.
      Returns:
      CitizenDataView for the citizen.

    • handleColonyViewMessage

      @Nullable public @Nullable IMessage handleColonyViewMessage(@NotNull @NotNull net.minecraft.network.FriendlyByteBuf buf, @NotNull @NotNull net.minecraft.world.level.Level world, boolean isNewSubscription)
      Populate a ColonyView from the network data.
      Specified by:
      handleColonyViewMessage in interface IColonyView
      Parameters:
      buf - FriendlyByteBuf to read from.
      isNewSubscription - Whether this is a new subscription of not.
      world - the world it is in.
      Returns:
      null == no response.

    • handlePermissionsViewMessage

      @Nullable public @Nullable IMessage handlePermissionsViewMessage(@NotNull @NotNull net.minecraft.network.FriendlyByteBuf buf)
      Update permissions.
      Specified by:
      handlePermissionsViewMessage in interface IColonyView
      Parameters:
      buf - buffer containing permissions.
      Returns:
      null == no response

    • handleColonyViewWorkOrderMessage

      @Nullable public @Nullable IMessage handleColonyViewWorkOrderMessage(net.minecraft.network.FriendlyByteBuf buf)
      Update a ColonyView's workOrders given a network data ColonyView update packet. This uses a full-replacement - workOrders do not get updated and are instead overwritten.
      Specified by:
      handleColonyViewWorkOrderMessage in interface IColonyView
      Parameters:
      buf - Network data.
      Returns:
      null == no response.

    • handleColonyViewCitizensMessage

      @Nullable public @Nullable IMessage handleColonyViewCitizensMessage(int id, net.minecraft.network.FriendlyByteBuf buf)
      Update a ColonyView's citizens given a network data ColonyView update packet. The ICitizenManager makes sure to update citizens instead of replacing them.
      Specified by:
      handleColonyViewCitizensMessage in interface IColonyView
      Parameters:
      id - ID of the citizen.
      buf - Network data.
      Returns:
      null == no response.

    • handleColonyViewVisitorMessage

      public void handleColonyViewVisitorMessage(net.minecraft.network.FriendlyByteBuf visitorBuf, boolean refresh)
      Description copied from interface: IColonyView
      Handles visitor view messages
      Specified by:
      handleColonyViewVisitorMessage in interface IColonyView
      Parameters:
      visitorBuf - the new data to set
      refresh - if all need to be refreshed.

    • handleColonyViewAnimalMessage

      public void handleColonyViewAnimalMessage(net.minecraft.network.FriendlyByteBuf animalBuf, boolean refresh)
      Handles animal view messages
      Specified by:
      handleColonyViewAnimalMessage in interface IColonyView
      Parameters:
      animalBuf - the new data to set
      refresh - if all need to be refreshed

    • handleColonyViewRemoveCitizenMessage

      @Nullable public @Nullable IMessage handleColonyViewRemoveCitizenMessage(int citizen)
      Remove a citizen from the ColonyView.
      Specified by:
      handleColonyViewRemoveCitizenMessage in interface IColonyView
      Parameters:
      citizen - citizen ID.
      Returns:
      null == no response.

    • handleColonyViewRemoveWorkOrderMessage

      @Nullable public @Nullable IMessage handleColonyViewRemoveWorkOrderMessage(int workOrderId)
      Remove a workOrder from the ColonyView.
      Specified by:
      handleColonyViewRemoveWorkOrderMessage in interface IColonyView
      Parameters:
      workOrderId - id of the workOrder.
      Returns:
      null == no response

    • handleColonyViewResearchManagerUpdate

      public void handleColonyViewResearchManagerUpdate(net.minecraft.nbt.CompoundTag compoundTag)
      Description copied from interface: IColonyView
      Handle the colony view research manager updating.
      Specified by:
      handleColonyViewResearchManagerUpdate in interface IColonyView
      Parameters:
      compoundTag - the tag to update the research manager with.

    • addPlayer

      public void addPlayer(String player)
      Update a players permissions.
      Specified by:
      addPlayer in interface IColonyView
      Parameters:
      player - player username.

    • removePlayer

      public void removePlayer(UUID player)
      Remove player from colony permissions.
      Specified by:
      removePlayer in interface IColonyView
      Parameters:
      player - the UUID of the player to remove.

    • getOverallHappiness

      public double getOverallHappiness()
      Getter for the overall happiness.
      Specified by:
      getOverallHappiness in interface IColony
      Specified by:
      getOverallHappiness in interface IColonyView
      Returns:
      the happiness, a double.

    • getCenter

      public net.minecraft.core.BlockPos getCenter()
      Description copied from interface: IColony
      Returns the position of the colony.
      Specified by:
      getCenter in interface IColony
      Specified by:
      getCenter in interface IColonyView
      Returns:
      pos of the colony.

    • getName

      public String getName()
      Description copied from interface: IColony
      Returns the name of the colony.
      Specified by:
      getName in interface IColony
      Specified by:
      getName in interface IColonyView
      Returns:
      Name of the colony.

    • getTeamColonyColor

      public net.minecraft.ChatFormatting getTeamColonyColor()
      Getter for the team colony color.
      Specified by:
      getTeamColonyColor in interface IColony
      Returns:
      the color.

    • getColonyFlag

      public net.minecraft.nbt.ListTag getColonyFlag()
      Getter for the pattern list of the colony flag
      Specified by:
      getColonyFlag in interface IColony
      Returns:
      the ListNBT of flag (banner) patterns

    • setName

      public void setName(String name)
      Sets the name of the view.
      Specified by:
      setName in interface IColony
      Specified by:
      setName in interface IColonyView
      Parameters:
      name - Name of the view.

    • getPermissions

      @NotNull public @NotNull IPermissions getPermissions()
      Description copied from interface: IColony
      Returns the permissions of the colony.
      Specified by:
      getPermissions in interface IColony
      Specified by:
      getPermissions in interface IColonyView
      Returns:
      IPermissions of the colony.

    • isCoordInColony

      public boolean isCoordInColony(@NotNull @NotNull net.minecraft.world.level.Level w, @NotNull @NotNull net.minecraft.core.BlockPos pos)
      Description copied from interface: IColony
      Determine if a given chunk coordinate is considered to be within the colony's bounds.
      Specified by:
      isCoordInColony in interface IColony
      Specified by:
      isCoordInColony in interface IColonyView
      Parameters:
      w - World to check.
      pos - Block Position.
      Returns:
      True if inside colony, otherwise false.

    • getDistanceSquared

      public long getDistanceSquared(@NotNull @NotNull net.minecraft.core.BlockPos pos)
      Description copied from interface: IColony
      Returns the squared (x, z) distance to the center.
      Specified by:
      getDistanceSquared in interface IColony
      Specified by:
      getDistanceSquared in interface IColonyView
      Parameters:
      pos - Block Position.
      Returns:
      Squared distance to the center in (x, z) direction.

    • getID

      public int getID()
      Returns the ID of the view.
      Specified by:
      getID in interface IColony
      Specified by:
      getID in interface IColonyView
      Returns:
      ID of the view.

    • isDay

      public boolean isDay()
      Description copied from interface: IColony
      Whether it is day for the colony
      Specified by:
      isDay in interface IColony
      Returns:
      true if it is day

    • getLastContactInHours

      public int getLastContactInHours()
      Description copied from interface: IColony
      Get the last contact of a player to the colony in hours.
      Specified by:
      getLastContactInHours in interface IColony
      Specified by:
      getLastContactInHours in interface IColonyView
      Returns:
      an integer with a describing value.

    • getWorld

      public net.minecraft.world.level.Level getWorld()
      Description copied from interface: IColony
      Method to get the World this colony is in.
      Specified by:
      getWorld in interface IColony
      Specified by:
      getWorld in interface IColonyView
      Returns:
      the World the colony is in.

    • getRequestManager

      @NotNull public @NotNull IRequestManager getRequestManager()
      Description copied from interface: IColony
      Get the current IRequestManager for this Colony. Returns null if the current Colony does not support the request system.
      Specified by:
      getRequestManager in interface IColony
      Specified by:
      getRequestManager in interface IColonyView
      Returns:
      the IRequestManager for this colony, null if not supported.

    • markDirty

      public void markDirty()
      Description copied from interface: IColony
      Called to mark this colony dirty, and in need of syncing / saving.
      Specified by:
      markDirty in interface IColony
      Specified by:
      markDirty in interface IColonyView

    • canBeAutoDeleted

      public boolean canBeAutoDeleted()
      Description copied from interface: IColony
      Called to check if the colony can be deleted by an automatic cleanup.
      Specified by:
      canBeAutoDeleted in interface IColony
      Specified by:
      canBeAutoDeleted in interface IColonyView
      Returns:
      true if so.

    • getRequesterBuildingForPosition

      @Nullable public @Nullable IRequester getRequesterBuildingForPosition(@NotNull @NotNull net.minecraft.core.BlockPos pos)
      Description copied from interface: IColony
      Method used to get a IRequester from a given Position. Is always a Building.
      Specified by:
      getRequesterBuildingForPosition in interface IColony
      Specified by:
      getRequesterBuildingForPosition in interface IColonyView
      Parameters:
      pos - The position to get the Building that acts as a requester.
      Returns:
      The IRequester from the position, or null.

    • removeVisitingPlayer

      public void removeVisitingPlayer(net.minecraft.world.entity.player.Player player)
      Description copied from interface: IColony
      Remove a visiting player.
      Specified by:
      removeVisitingPlayer in interface IColony
      Specified by:
      removeVisitingPlayer in interface IColonyView
      Parameters:
      player - the player.

    • getMessagePlayerEntities

      @NotNull public @NotNull List<net.minecraft.world.entity.player.Player> getMessagePlayerEntities()
      Description copied from interface: IColony
      Get the players in the colony which should receive the message.
      Specified by:
      getMessagePlayerEntities in interface IColony
      Returns:
      list of players

    • addVisitingPlayer

      public void addVisitingPlayer(net.minecraft.world.entity.player.Player player)
      Description copied from interface: IColony
      Add a visiting player.
      Specified by:
      addVisitingPlayer in interface IColony
      Specified by:
      addVisitingPlayer in interface IColonyView
      Parameters:
      player - the player.

    • onWorldLoad

      public void onWorldLoad(@NotNull @NotNull net.minecraft.world.level.Level w)
      Specified by:
      onWorldLoad in interface IColony

    • onWorldUnload

      public void onWorldUnload(@NotNull @NotNull net.minecraft.world.level.Level w)
      Specified by:
      onWorldUnload in interface IColony

    • onServerTick

      public void onServerTick(@NotNull net.minecraftforge.event.TickEvent.ServerTickEvent event)
      Specified by:
      onServerTick in interface IColony

    • getWorkManager

      @NotNull public @NotNull IWorkManager getWorkManager()
      Specified by:
      getWorkManager in interface IColony

    • onWorldTick

      public void onWorldTick(@NotNull net.minecraftforge.event.TickEvent.LevelTickEvent event)
      Specified by:
      onWorldTick in interface IColony

    • getWayPoints

      public Map<net.minecraft.core.BlockPos,net.minecraft.world.level.block.state.BlockState> getWayPoints()
      Specified by:
      getWayPoints in interface IColony

    • getLastSpawnPoints

      public List<net.minecraft.core.BlockPos> getLastSpawnPoints()
      Get a list of all barb spawn positions in the colony view.
      Specified by:
      getLastSpawnPoints in interface IColonyView
      Returns:
      a copy of the list.

    • isRemote

      public boolean isRemote()
      Description copied from interface: IColony
      Check if the colony is on the server or client.
      Specified by:
      isRemote in interface IColony
      Specified by:
      isRemote in interface IColonyView
      Returns:
      true if so.

    • getColonyTag

      public net.minecraft.nbt.CompoundTag getColonyTag()
      Specified by:
      getColonyTag in interface IColony

    • isColonyUnderAttack

      public boolean isColonyUnderAttack()
      Specified by:
      isColonyUnderAttack in interface IColony

    • isValidAttackingPlayer

      public boolean isValidAttackingPlayer(net.minecraft.world.entity.player.Player entity)
      Specified by:
      isValidAttackingPlayer in interface IColony

    • addGuardToAttackers

      public void addGuardToAttackers(AbstractEntityCitizen entityCitizen, net.minecraft.world.entity.player.Player followPlayer)
      Specified by:
      addGuardToAttackers in interface IColony

    • setColonyColor

      public void setColonyColor(net.minecraft.ChatFormatting color)
      Specified by:
      setColonyColor in interface IColony

    • setColonyFlag

      public void setColonyFlag(net.minecraft.nbt.ListTag colonyFlag)
      Specified by:
      setColonyFlag in interface IColony

    • getImportantMessageEntityPlayers

      @NotNull public @NotNull List<net.minecraft.world.entity.player.Player> getImportantMessageEntityPlayers()
      Description copied from interface: IColony
      Returns a set of players receiving important messages for the colony.
      Specified by:
      getImportantMessageEntityPlayers in interface IColony
      Returns:
      set of players.

    • getStructurePack

      public String getStructurePack()
      Get the style of the colony.
      Specified by:
      getStructurePack in interface IColony
      Specified by:
      getStructurePack in interface IColonyView
      Returns:
      the current default style.

    • setStructurePack

      public void setStructurePack(String style)
      Specified by:
      setStructurePack in interface IColony

    • getServerBuildingManager

      public IRegisteredStructureManager getServerBuildingManager()
      Specified by:
      getServerBuildingManager in interface IColony

    • getCommonBuildingManager

      public ICommonRegisteredStructureManager getCommonBuildingManager()
      Specified by:
      getCommonBuildingManager in interface IColony

    • getGraveManager

      public IGraveManager getGraveManager()
      Specified by:
      getGraveManager in interface IColony

    • getCitizenManager

      public ICitizenManager getCitizenManager()
      Specified by:
      getCitizenManager in interface IColony

    • getVisitorManager

      public IVisitorManager getVisitorManager()
      Description copied from interface: IColony
      Gets the visitor manager
      Specified by:
      getVisitorManager in interface IColony
      Returns:
      manager

    • getAnimalManager

      public IAnimalManager getAnimalManager()
      Gets the animal manager of the colony view.
      Specified by:
      getAnimalManager in interface IColony
      Returns:
      null in the view

    • getRaiderManager

      public IRaiderManager getRaiderManager()
      Specified by:
      getRaiderManager in interface IColony

    • getEventManager

      public IEventManager getEventManager()
      Description copied from interface: IColony
      Get the event manager of the colony.
      Specified by:
      getEventManager in interface IColony
      Returns:
      the event manager.

    • getReproductionManager

      public IReproductionManager getReproductionManager()
      Description copied from interface: IColony
      Get the reproduction manager of the colony.
      Specified by:
      getReproductionManager in interface IColony
      Returns:
      the reproduction manager.

    • getEventDescriptionManager

      public IEventDescriptionManager getEventDescriptionManager()
      Description copied from interface: IColony
      Get the event description manager of the colony.
      Specified by:
      getEventDescriptionManager in interface IColony
      Returns:
      the event description manager.

    • getPackageManager

      public IColonyPackageManager getPackageManager()
      Description copied from interface: IColony
      The colony networking packaging manager.
      Specified by:
      getPackageManager in interface IColony
      Returns:
      The packaging manager.

    • getTravellingManager

      public ITravellingManager getTravellingManager()
      Description copied from interface: IColony
      Get the travelling manager of the colony.
      Specified by:
      getTravellingManager in interface IColony
      Returns:
      the travelling manager.

    • getConnectionManager

      public IColonyConnectionManager getConnectionManager()
      Description copied from interface: IColony
      Get the connection manager of the colony.
      Specified by:
      getConnectionManager in interface IColony
      Returns:
      the connection manager.

    • isRaiding

      public boolean isRaiding()
      Description copied from interface: IColonyView
      If currently being raided.
      Specified by:
      isRaiding in interface IColonyView
      Returns:
      true if so.

    • getMercenaryUseTime

      public long getMercenaryUseTime()
      Description copied from interface: IColony
      Get the last time mercenaries were used.
      Specified by:
      getMercenaryUseTime in interface IColony
      Returns:
      the mercenary use time.

    • usedMercenaries

      public void usedMercenaries()
      Description copied from interface: IColony
      Save the time when mercenaries are used, to set a cooldown.
      Specified by:
      usedMercenaries in interface IColony

    • getResearchManager

      public IResearchManager getResearchManager()
      Description copied from interface: IColony
      Get the research manager.
      Specified by:
      getResearchManager in interface IColony
      Returns:
      the research manager object.

    • areSpiesEnabled

      public boolean areSpiesEnabled()
      Specified by:
      areSpiesEnabled in interface IColonyView

    • getVisitor

      public ICitizenDataView getVisitor(int citizenId)
      Description copied from interface: IColonyView
      Gets the data view for a visitor
      Specified by:
      getVisitor in interface IColonyView
      Parameters:
      citizenId - id to query
      Returns:
      citizen data for visitor

    • getAnimal

      public IAnimalDataView getAnimal(int animalId)
      Description copied from interface: IColonyView
      Gets the data view for an animal
      Specified by:
      getAnimal in interface IColonyView
      Parameters:
      animalId - id to query
      Returns:
      animal data for visitor

    • setNameStyle

      public void setNameStyle(String style)
      Description copied from interface: IColony
      Set the colony name style.
      Specified by:
      setNameStyle in interface IColony
      Parameters:
      style - the string id of the style.

    • getNameStyle

      public String getNameStyle()
      Description copied from interface: IColony
      Get the colony name style.
      Specified by:
      getNameStyle in interface IColony
      Returns:
      the string id of the style.

    • getNameFileIds

      public List<String> getNameFileIds()
      Description copied from interface: IColonyView
      Get a list of all available citizen name style options.
      Specified by:
      getNameFileIds in interface IColonyView
      Returns:
      the list of options.

    • getCitizenNameFile

      public CitizenNameFile getCitizenNameFile()
      Description copied from interface: IColony
      Get the matching citizen name file of the colony .
      Specified by:
      getCitizenNameFile in interface IColony
      Returns:
      the matching file.

    • getStatisticsManager

      public IStatisticsManager getStatisticsManager()
      Description copied from interface: IColony
      Get the statistics manager of the colony.
      Specified by:
      getStatisticsManager in interface IColony
      Returns:
      the statistics manager.

    • getDay

      public int getDay()
      Description copied from interface: IColony
      Get the current day of the colony.
      Specified by:
      getDay in interface IColony
      Returns:
      the current day progress of the colony.

    • getQuestManager

      public IQuestManager getQuestManager()
      Description copied from interface: IColony
      Get the quest manager of the colony.
      Specified by:
      getQuestManager in interface IColony
      Returns:
      the quest manager.

    • getClientBuildingManager

      public IRegisteredStructureManagerView getClientBuildingManager()
      Description copied from interface: IColonyView
      Client side building manager.
      Specified by:
      getClientBuildingManager in interface IColonyView
      Returns:
      the client side building manager

    • getSettings

      public ICommonSettingsModule getSettings()
      Description copied from interface: IColony
      Get the colony level settings module.
      Specified by:
      getSettings in interface IColony
      Returns:
      the settings module.