Package com.minecolonies.core.colony.buildingextensions

Class AbstractBuildingExtensionModule

java.lang.Object

com.minecolonies.core.colony.buildingextensions.AbstractBuildingExtensionModule

All Implemented Interfaces:

IBuildingExtension, IModuleContainer<IBuildingExtensionModule>

Direct Known Subclasses:

FarmField, PlantationField

public abstract class AbstractBuildingExtensionModule
extends Object
implements IBuildingExtension

Abstract implementation for building extension instances. Contains some basic mandatory logic for building extensions.

Nested Class Summary

Nested classes/interfaces inherited from interface com.minecolonies.api.colony.buildingextensions.IBuildingExtension

IBuildingExtension.ExtensionId

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuildingExtensionModule(BuildingExtensionRegistries.BuildingExtensionEntry buildingExtensionEntry, @NotNull net.minecraft.core.BlockPos position)	Constructor used in NBT deserialization.

Method Summary

Modifier and Type	Method	Description
void	deserialize(@NotNull net.minecraft.network.FriendlyByteBuf buf)	Deserialize a building extension from a buffer.
void	deserializeNBT(@NotNull net.minecraft.nbt.CompoundTag compound)	Reconstruct the building extension from the given NBT data.
boolean	equals(Object o)	Equals implementation for this building extension.
final BuildingExtensionRegistries.BuildingExtensionEntry	getBuildingExtensionType()	Return the building extension type for this building extension.
final @Nullable net.minecraft.core.BlockPos	getBuildingId()	Getter for the owning building of the building extension.
@NotNull Class<IBuildingExtensionModule>	getClassType()	Get the class type of the module container.
IBuildingExtension.ExtensionId	getId()	Get the unique extension id.
@NotNull List<IBuildingExtensionModule>	getModules()	Get a list containing all modules registered to this container.
final @NotNull net.minecraft.core.BlockPos	getPosition()	Gets the position of the building extension.
final int	getSqDistance(IBuildingView building)	Get the distance to a building.
int	hashCode()	Hashcode implementation for this building extension.
final boolean	isTaken()	Has the building extension been taken.
void	registerModule(@NotNull IBuildingExtensionModule module)	Register a specific module to the object.
final void	resetOwningBuilding()	Resets the ownership of the building extension.
void	serialize(@NotNull net.minecraft.network.FriendlyByteBuf buf)	Serialize a building extension to a buffer.
@NotNull net.minecraft.nbt.CompoundTag	serializeNBT()	Stores the NBT data of the building extension.
final void	setBuilding(net.minecraft.core.BlockPos buildingId)	Sets the owning building of the building extension.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.minecolonies.api.colony.buildingextensions.IBuildingExtension

isValidPlacement

Methods inherited from interface com.minecolonies.api.colony.modules.IModuleContainer

getFirstModuleOccurance, getModule, getModule, getModule, getModuleMatching, getModules, getModules, getModules, getModulesByType, hasModule, hasModule, hasModule

Constructor Details

AbstractBuildingExtensionModule

protected AbstractBuildingExtensionModule(@NotNull
 BuildingExtensionRegistries.BuildingExtensionEntry buildingExtensionEntry,
 @NotNull
 @NotNull net.minecraft.core.BlockPos position)

Constructor used in NBT deserialization.

Parameters:

buildingExtensionEntry - the type of building extension.

position - the position of the building extension.

Method Details

getModules

@NotNull
public @NotNull List<IBuildingExtensionModule> getModules()

Description copied from interface: IModuleContainer

Get a list containing all modules registered to this container.

Specified by:

getModules in interface IModuleContainer<IBuildingExtensionModule>

Returns:

the list of all modules.

getClassType

@NotNull
public @NotNull Class<IBuildingExtensionModule> getClassType()

Description copied from interface: IModuleContainer

Get the class type of the module container.

Specified by:

getClassType in interface IModuleContainer<IBuildingExtensionModule>

Returns:

the class type.

registerModule

public void registerModule(@NotNull
 @NotNull IBuildingExtensionModule module)

Description copied from interface: IBuildingExtension

Register a specific module to the object.

Specified by:

registerModule in interface IBuildingExtension

Parameters:

module - the module to register.

getBuildingExtensionType

@NotNull
public final BuildingExtensionRegistries.BuildingExtensionEntry getBuildingExtensionType()

Description copied from interface: IBuildingExtension

Return the building extension type for this building extension.

Specified by:

getBuildingExtensionType in interface IBuildingExtension

Returns:

the building extension registry entry.

getPosition

@NotNull
public final @NotNull net.minecraft.core.BlockPos getPosition()

Description copied from interface: IBuildingExtension

Gets the position of the building extension.

Specified by:

getPosition in interface IBuildingExtension

Returns:

central location of the building extension.

getBuildingId

@Nullable
public final @Nullable net.minecraft.core.BlockPos getBuildingId()

Description copied from interface: IBuildingExtension

Getter for the owning building of the building extension.

Specified by:

getBuildingId in interface IBuildingExtension

Returns:

the id or null.

setBuilding

public final void setBuilding(net.minecraft.core.BlockPos buildingId)

Description copied from interface: IBuildingExtension

Sets the owning building of the building extension.

Specified by:

setBuilding in interface IBuildingExtension

Parameters:

buildingId - id of the building.

resetOwningBuilding

public final void resetOwningBuilding()

Description copied from interface: IBuildingExtension

Resets the ownership of the building extension.

Specified by:

resetOwningBuilding in interface IBuildingExtension

isTaken

public final boolean isTaken()

Description copied from interface: IBuildingExtension

Has the building extension been taken.

Specified by:

isTaken in interface IBuildingExtension

Returns:

true if the building extension is not free to use, false after releasing it.

getSqDistance

public final int getSqDistance(IBuildingView building)

Description copied from interface: IBuildingExtension

Get the distance to a building.

Specified by:

getSqDistance in interface IBuildingExtension

Parameters:

building - the building to get the distance to.

Returns:

the distance

serializeNBT

@NotNull
public @NotNull net.minecraft.nbt.CompoundTag serializeNBT()

Description copied from interface: IBuildingExtension

Stores the NBT data of the building extension.

Specified by:

serializeNBT in interface IBuildingExtension

deserializeNBT

public void deserializeNBT(@NotNull
 @NotNull net.minecraft.nbt.CompoundTag compound)

Description copied from interface: IBuildingExtension

Reconstruct the building extension from the given NBT data.

Specified by:

deserializeNBT in interface IBuildingExtension

Parameters:

compound - the compound to read from.

serialize

public void serialize(@NotNull
 @NotNull net.minecraft.network.FriendlyByteBuf buf)

Description copied from interface: IBuildingExtension

Serialize a building extension to a buffer.

Specified by:

serialize in interface IBuildingExtension

Parameters:

buf - the buffer to write the building extension data to.

deserialize

public void deserialize(@NotNull
 @NotNull net.minecraft.network.FriendlyByteBuf buf)

Description copied from interface: IBuildingExtension

Deserialize a building extension from a buffer.

Specified by:

deserialize in interface IBuildingExtension

Parameters:

buf - the buffer to read the building extension data from.

hashCode

public int hashCode()

Description copied from interface: IBuildingExtension

Hashcode implementation for this building extension.

Specified by:

hashCode in interface IBuildingExtension

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Description copied from interface: IBuildingExtension

Equals implementation for this building extension.

Specified by:

equals in interface IBuildingExtension

Overrides:

equals in class Object

getId

public IBuildingExtension.ExtensionId getId()

Description copied from interface: IBuildingExtension

Get the unique extension id.

Specified by:

getId in interface IBuildingExtension

Returns:

the unique id.