Package com.minecolonies.core.colony.managers

Class RegisteredStructureManager

java.lang.Object

com.minecolonies.core.colony.managers.RegisteredStructureManager

All Implemented Interfaces:

ICommonRegisteredStructureManager<IBuilding,ITownHall>, IRegisteredStructureManager

public class RegisteredStructureManager
extends Object
implements IRegisteredStructureManager

Constructor Summary

Constructors

Constructor	Description
RegisteredStructureManager(Colony colony)	Creates the BuildingManager for a colony.

Method Summary

Modifier and Type	Method	Description
boolean	addBuildingExtension(IBuildingExtension extension)	Add a new building extension to the building manager.
void	addBuildingExtensionIfMissing(BuildingExtensionRegistries.BuildingExtensionEntry buildingExtensionEntry, net.minecraft.core.BlockPos pos, net.minecraft.world.entity.player.Player player)	Add a building extension if it's missing.
void	addLeisureSite(net.minecraft.core.BlockPos pos)	Register a new leisure site.
IBuilding	addNewBuilding(@NotNull AbstractTileEntityColonyBuilding tileEntity, net.minecraft.world.level.Level world)	Creates a building from a tile entity and adds it to the colony.
boolean	canPlaceAt(net.minecraft.world.level.block.Block block, net.minecraft.core.BlockPos pos, net.minecraft.world.entity.player.Player player)	Checks whether we're allowed to place the block for a new building
void	cleanUpBuildings(@NotNull IColony colony)	Clean up the buildings.
void	clearDirty()	Clear the isDirty of the buildings.
void	clearPendingPrestigeCalc(IBuilding building)	Indicate to building manager that prestige just has been calculated.
@NotNull List<IBuildingExtension>	getBuildingExtensions(Predicate<IBuildingExtension> matcher)	Get all the building extensions.
@NotNull Map<net.minecraft.core.BlockPos,IBuilding>	getBuildings()	Returns a map with all buildings within the colony.
@Nullable IWareHouse	getClosestWarehouseInColony(net.minecraft.core.BlockPos pos)	Get the closest warehouse relative to a position.
Colony	getColony()	Get the colony from the manager.
int	getColonyPrestige()	Get the colony prestige.
IBuilding	getHouseWithSpareBed()	Get a house with a spare bed.
List<net.minecraft.core.BlockPos>	getLeisureSites()	Get the leisure site positions.
@Nullable IBuildingExtension	getMatchingBuildingExtension(IBuildingExtension.ExtensionId extensionId)	Get a building extension by id.
Optional<IBuildingExtension>	getMatchingBuildingExtension(Predicate<IBuildingExtension> matcher)	Get a specific building extension on the given location.
int	getMysticalSiteMaxBuildingLevel()	Get the maximum level among built mystical sites
List<IMysticalSite>	getMysticalSites()	Get a list of the mystical sites in this colony.
net.minecraft.core.BlockPos	getRandomLeisureSite()	Get a random leisure site to go to.
@Nullable ITownHall	getTownHall()	Get the townhall from the colony.
List<IWareHouse>	getWareHouses()	Get a list of the warehouses in this colony.
void	guardBuildingChangedAt(IBuilding guardBuilding, int newLevel)	Event once a guard building changed at a certain level.
boolean	hasGuardBuildingNear(IBuilding building)	Finds whether there is a guard building close to the given building
boolean	hasMysticalSite()	Check if the colony has a placed mystical site.
boolean	hasTownHall()	Check if the colony has a placed townhall.
boolean	hasWarehouse()	Check if the colony has a placed warehouse.
boolean	keepChunkColonyLoaded(net.minecraft.world.level.chunk.LevelChunk chunk)	Is this chunk claimed by enough buildings to keep it loaded.
void	markBuildingExtensionsDirty()	Updates all subscribers of building extensions etc.
void	markBuildingsDirty()	Marks building data dirty.
void	onBuildingUpgradeComplete(@Nullable IBuilding building, int level)	Performed when a building of this colony finished his upgrade state.
void	onColonyTick(IColony colony)	Tick the buildings on colony tick.
void	read(net.minecraft.core.HolderLookup.Provider provider, @NotNull net.minecraft.nbt.CompoundTag compound)	Read the buildings from NBT.
void	removeBuilding(@NotNull IBuilding building, Set<net.minecraft.server.level.ServerPlayer> subscribers)	Remove a IBuilding from the Colony (when it is destroyed).
void	removeBuildingExtension(Predicate<IBuildingExtension> matcher)	Remove a building extension from the building extension collection.
void	removeLeisureSite(net.minecraft.core.BlockPos pos)	Remove a leisure site.
void	removeMysticalSite(IMysticalSite mysticalSite)	Removes a warehouse from the BuildingManager
void	removeWareHouse(IWareHouse wareHouse)	Removes a warehouse from the BuildingManager
void	sendPackets(Set<net.minecraft.server.level.ServerPlayer> closeSubscribers, Set<net.minecraft.server.level.ServerPlayer> newSubscribers)	Send packets of the buildings to the subscribers.
void	setTownHall(@Nullable ITownHall building)	Set the townhall building.
void	write(net.minecraft.core.HolderLookup.Provider provider, @NotNull net.minecraft.nbt.CompoundTag compound)	Write the buildings to NBT.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.minecolonies.api.colony.managers.interfaces.ICommonRegisteredStructureManager

getBestBuilding, getBestBuilding, getBestBuilding, getBestBuilding, getBuilding, getBuilding, getFirstBuildingMatching, getRandomBuilding, hasBuilding

Constructor Details

RegisteredStructureManager

public RegisteredStructureManager(Colony colony)

Creates the BuildingManager for a colony.

Parameters:

colony - the colony.

Method Details

read

public void read(@NotNull
 net.minecraft.core.HolderLookup.Provider provider,
 @NotNull
 @NotNull net.minecraft.nbt.CompoundTag compound)

Description copied from interface: IRegisteredStructureManager

Read the buildings from NBT.

Specified by:

read in interface IRegisteredStructureManager

Parameters:

compound - the compound.

write

public void write(@NotNull
 net.minecraft.core.HolderLookup.Provider provider,
 @NotNull
 @NotNull net.minecraft.nbt.CompoundTag compound)

Description copied from interface: IRegisteredStructureManager

Write the buildings to NBT.

Specified by:

write in interface IRegisteredStructureManager

Parameters:

compound - the compound.

clearDirty

public void clearDirty()

Description copied from interface: IRegisteredStructureManager

Clear the isDirty of the buildings.

Specified by:

clearDirty in interface IRegisteredStructureManager

sendPackets

public void sendPackets(Set<net.minecraft.server.level.ServerPlayer> closeSubscribers,
 Set<net.minecraft.server.level.ServerPlayer> newSubscribers)

Description copied from interface: IRegisteredStructureManager

Send packets of the buildings to the subscribers.

Specified by:

sendPackets in interface IRegisteredStructureManager

Parameters:

closeSubscribers - the old subs.

newSubscribers - new subs.

onColonyTick

public void onColonyTick(IColony colony)

Description copied from interface: IRegisteredStructureManager

Tick the buildings on colony tick.

Specified by:

onColonyTick in interface IRegisteredStructureManager

Parameters:

colony - the event.

clearPendingPrestigeCalc

public void clearPendingPrestigeCalc(IBuilding building)

Description copied from interface: IRegisteredStructureManager

Indicate to building manager that prestige just has been calculated.

Specified by:

clearPendingPrestigeCalc in interface IRegisteredStructureManager

Parameters:

building - the building it happened for.

getColonyPrestige

public int getColonyPrestige()

Description copied from interface: IRegisteredStructureManager

Get the colony prestige.

Specified by:

getColonyPrestige in interface IRegisteredStructureManager

Returns:

the prestige.

markBuildingsDirty

public void markBuildingsDirty()

Description copied from interface: IRegisteredStructureManager

Marks building data dirty.

Specified by:

markBuildingsDirty in interface IRegisteredStructureManager

cleanUpBuildings

public void cleanUpBuildings(@NotNull
 @NotNull IColony colony)

Description copied from interface: IRegisteredStructureManager

Clean up the buildings.

Specified by:

cleanUpBuildings in interface IRegisteredStructureManager

Parameters:

colony - at the worldTick event.

getLeisureSites

public List<net.minecraft.core.BlockPos> getLeisureSites()

Description copied from interface: IRegisteredStructureManager

Get the leisure site positions.

Specified by:

getLeisureSites in interface IRegisteredStructureManager

Returns:

the list.

getRandomLeisureSite

public net.minecraft.core.BlockPos getRandomLeisureSite()

Description copied from interface: IRegisteredStructureManager

Get a random leisure site to go to.

Specified by:

getRandomLeisureSite in interface IRegisteredStructureManager

Returns:

the position of it.

addLeisureSite

public void addLeisureSite(net.minecraft.core.BlockPos pos)

Description copied from interface: IRegisteredStructureManager

Register a new leisure site.

Specified by:

addLeisureSite in interface IRegisteredStructureManager

Parameters:

pos - the position of it.

removeLeisureSite

public void removeLeisureSite(net.minecraft.core.BlockPos pos)

Description copied from interface: IRegisteredStructureManager

Remove a leisure site.

Specified by:

removeLeisureSite in interface IRegisteredStructureManager

Parameters:

pos - the position of it.

getClosestWarehouseInColony

@Nullable
public @Nullable IWareHouse getClosestWarehouseInColony(net.minecraft.core.BlockPos pos)

Description copied from interface: IRegisteredStructureManager

Get the closest warehouse relative to a position.

Specified by:

getClosestWarehouseInColony in interface IRegisteredStructureManager

Parameters:

pos - the position,.

Returns:

the closest warehouse.

keepChunkColonyLoaded

public boolean keepChunkColonyLoaded(net.minecraft.world.level.chunk.LevelChunk chunk)

Description copied from interface: IRegisteredStructureManager

Is this chunk claimed by enough buildings to keep it loaded.

Specified by:

keepChunkColonyLoaded in interface IRegisteredStructureManager

Parameters:

chunk - the chunk to check

Returns:

true if within.

getHouseWithSpareBed

public IBuilding getHouseWithSpareBed()

Description copied from interface: IRegisteredStructureManager

Get a house with a spare bed.

Specified by:

getHouseWithSpareBed in interface IRegisteredStructureManager

Returns:

the house or null.

getBuildings

@NotNull
public @NotNull Map<net.minecraft.core.BlockPos,IBuilding> getBuildings()

Description copied from interface: ICommonRegisteredStructureManager

Returns a map with all buildings within the colony. Key is ID (Coordinates), value is building object.

Specified by:

getBuildings in interface ICommonRegisteredStructureManager<IBuilding,ITownHall>

Returns:

Map with ID (coordinates) as key, and buildings as value.

getTownHall

@Nullable
public @Nullable ITownHall getTownHall()

Description copied from interface: ICommonRegisteredStructureManager

Get the townhall from the colony.

Specified by:

getTownHall in interface ICommonRegisteredStructureManager<IBuilding,ITownHall>

Returns:

the townhall building.

getMysticalSiteMaxBuildingLevel

public int getMysticalSiteMaxBuildingLevel()

Description copied from interface: IRegisteredStructureManager

Get the maximum level among built mystical sites

Specified by:

getMysticalSiteMaxBuildingLevel in interface IRegisteredStructureManager

Returns:

the max level among all mystical sites or zero if no mystical site built

hasWarehouse

public boolean hasWarehouse()

Description copied from interface: ICommonRegisteredStructureManager

Check if the colony has a placed warehouse.

Specified by:

hasWarehouse in interface ICommonRegisteredStructureManager<IBuilding,ITownHall>

Returns:

true if so.

hasMysticalSite

public boolean hasMysticalSite()

Description copied from interface: IRegisteredStructureManager

Check if the colony has a placed mystical site.

Specified by:

hasMysticalSite in interface IRegisteredStructureManager

Returns:

true if so.

hasTownHall

public boolean hasTownHall()

Description copied from interface: ICommonRegisteredStructureManager

Check if the colony has a placed townhall.

Specified by:

hasTownHall in interface ICommonRegisteredStructureManager<IBuilding,ITownHall>

Returns:

true if so.

addNewBuilding

public IBuilding addNewBuilding(@NotNull
 @NotNull AbstractTileEntityColonyBuilding tileEntity,
 net.minecraft.world.level.Level world)

Description copied from interface: IRegisteredStructureManager

Creates a building from a tile entity and adds it to the colony.

Specified by:

addNewBuilding in interface IRegisteredStructureManager

Parameters:

tileEntity - Tile entity to build a building from.

world - the world to add it to.

Returns:

IBuilding that was created and added.

removeBuilding

public void removeBuilding(@NotNull
 @NotNull IBuilding building,
 Set<net.minecraft.server.level.ServerPlayer> subscribers)

Description copied from interface: IRegisteredStructureManager

Remove a IBuilding from the Colony (when it is destroyed).

Specified by:

removeBuilding in interface IRegisteredStructureManager

Parameters:

building - IBuilding to remove.

subscribers - the subscribers of the colony to message.

hasGuardBuildingNear

public boolean hasGuardBuildingNear(IBuilding building)

Finds whether there is a guard building close to the given building

Specified by:

hasGuardBuildingNear in interface IRegisteredStructureManager

Parameters:

building - the building to check.

Returns:

false if no guard tower close, true in other cases

guardBuildingChangedAt

public void guardBuildingChangedAt(IBuilding guardBuilding,
 int newLevel)

Description copied from interface: IRegisteredStructureManager

Event once a guard building changed at a certain level.

Specified by:

guardBuildingChangedAt in interface IRegisteredStructureManager

Parameters:

guardBuilding - the guard building.

newLevel - the level of it.

setTownHall

public void setTownHall(@Nullable
 @Nullable ITownHall building)

Description copied from interface: IRegisteredStructureManager

Set the townhall building.

Specified by:

setTownHall in interface IRegisteredStructureManager

Parameters:

building - the building to set.

getWareHouses

public List<IWareHouse> getWareHouses()

Description copied from interface: IRegisteredStructureManager

Get a list of the warehouses in this colony.

Specified by:

getWareHouses in interface IRegisteredStructureManager

Returns:

the warehouse.

removeWareHouse

public void removeWareHouse(IWareHouse wareHouse)

Description copied from interface: IRegisteredStructureManager

Removes a warehouse from the BuildingManager

Specified by:

removeWareHouse in interface IRegisteredStructureManager

Parameters:

wareHouse - the warehouse to remove.

getMysticalSites

public List<IMysticalSite> getMysticalSites()

Description copied from interface: IRegisteredStructureManager

Get a list of the mystical sites in this colony.

Specified by:

getMysticalSites in interface IRegisteredStructureManager

Returns:

the list of mistical sites.

removeMysticalSite

public void removeMysticalSite(IMysticalSite mysticalSite)

Description copied from interface: IRegisteredStructureManager

Removes a warehouse from the BuildingManager

Specified by:

removeMysticalSite in interface IRegisteredStructureManager

Parameters:

mysticalSite - the warehouse to remove.

markBuildingExtensionsDirty

public void markBuildingExtensionsDirty()

Updates all subscribers of building extensions etc.

Specified by:

markBuildingExtensionsDirty in interface IRegisteredStructureManager

canPlaceAt

public boolean canPlaceAt(net.minecraft.world.level.block.Block block,
 net.minecraft.core.BlockPos pos,
 net.minecraft.world.entity.player.Player player)

Description copied from interface: IRegisteredStructureManager

Checks whether we're allowed to place the block for a new building

Specified by:

canPlaceAt in interface IRegisteredStructureManager

Parameters:

block - Block to check

pos - position

player - the player trying to place

Returns:

true if placement allowed

onBuildingUpgradeComplete

public void onBuildingUpgradeComplete(@Nullable
 @Nullable IBuilding building,
 int level)

Description copied from interface: IRegisteredStructureManager

Performed when a building of this colony finished his upgrade state.

Specified by:

onBuildingUpgradeComplete in interface IRegisteredStructureManager

Parameters:

building - The upgraded building.

level - The new level.

getBuildingExtensions

@NotNull
public @NotNull List<IBuildingExtension> getBuildingExtensions(Predicate<IBuildingExtension> matcher)

Description copied from interface: ICommonRegisteredStructureManager

Get all the building extensions.

Specified by:

getBuildingExtensions in interface ICommonRegisteredStructureManager<IBuilding,ITownHall>

Parameters:

matcher - the building extension matcher predicate.

Returns:

an unmodifiable collection of all building extensions.

getMatchingBuildingExtension

public Optional<IBuildingExtension> getMatchingBuildingExtension(Predicate<IBuildingExtension> matcher)

Description copied from interface: IRegisteredStructureManager

Get a specific building extension on the given location.

Specified by:

getMatchingBuildingExtension in interface IRegisteredStructureManager

Parameters:

matcher - the building extension matcher predicate.

Returns:

the building extension, if any.

addBuildingExtension

public boolean addBuildingExtension(IBuildingExtension extension)

Description copied from interface: IRegisteredStructureManager

Add a new building extension to the building manager. If an identical building extension already exists, this building extension won't be added.

Specified by:

addBuildingExtension in interface IRegisteredStructureManager

Parameters:

extension - the new building extension to add.

Returns:

true if the building extension was added.

removeBuildingExtension

public void removeBuildingExtension(Predicate<IBuildingExtension> matcher)

Description copied from interface: IRegisteredStructureManager

Remove a building extension from the building extension collection.

Specified by:

removeBuildingExtension in interface IRegisteredStructureManager

Parameters:

matcher - the building extension matcher predicate.

getMatchingBuildingExtension

@Nullable
public @Nullable IBuildingExtension getMatchingBuildingExtension(IBuildingExtension.ExtensionId extensionId)

Description copied from interface: IRegisteredStructureManager

Get a building extension by id.

Specified by:

getMatchingBuildingExtension in interface IRegisteredStructureManager

Parameters:

extensionId - the id of the extension.

Returns:

the building extension or null.

addBuildingExtensionIfMissing

public void addBuildingExtensionIfMissing(BuildingExtensionRegistries.BuildingExtensionEntry buildingExtensionEntry,
 net.minecraft.core.BlockPos pos,
 net.minecraft.world.entity.player.Player player)

Description copied from interface: IRegisteredStructureManager

Add a building extension if it's missing.

Specified by:

addBuildingExtensionIfMissing in interface IRegisteredStructureManager

Parameters:

buildingExtensionEntry - the entry to create the extension from.

pos - the pos it's at.

getColony

public Colony getColony()

Description copied from interface: ICommonRegisteredStructureManager

Get the colony from the manager.

Specified by:

getColony in interface ICommonRegisteredStructureManager<IBuilding,ITownHall>

Returns:

the IColony colony.