Package com.minecolonies.api.colony.colonyEvents.descriptions

Interface IBuildingEventDescription

All Superinterfaces:

IColonyEventDescription, net.minecraftforge.common.util.INBTSerializable<net.minecraft.nbt.CompoundTag>

All Known Implementing Classes:

AbstractBuildingEvent, BuildingBuiltEvent, BuildingDeconstructedEvent, BuildingRepairedEvent, BuildingUpgradedEvent

public interface IBuildingEventDescription
extends IColonyEventDescription

Event description for building events.

Method Summary

Modifier and Type	Method	Description
String	getBuildingName()	Gets the name of the building type involved in this event.
int	getLevel()	Gets the level of the building after the event.
void	setBuildingName(String buildingName)	Sets the building type for this event.
void	setLevel(int lvl)	Sets the level of the building after the event.
default String	toDisplayString()	Builds the string to show in the colony events list.

Methods inherited from interface com.minecolonies.api.colony.colonyEvents.descriptions.IColonyEventDescription

deserialize, getDay, getEventPos, getEventTypeId, getName, getSummaryTranslationKey, includeInSummary, serialize, setDay, setEventPos

Methods inherited from interface net.minecraftforge.common.util.INBTSerializable

deserializeNBT, serializeNBT

Method Details

getBuildingName

String getBuildingName()

Gets the name of the building type involved in this event.

Returns:

the name of the building type involved in this event.

setBuildingName

void setBuildingName(String buildingName)

Sets the building type for this event.

Parameters:

buildingName - the building type for this event.

getLevel

int getLevel()

Gets the level of the building after the event.

Returns:

the level of the building after the event.

setLevel

void setLevel(int lvl)

Sets the level of the building after the event.

Parameters:

lvl - the level of the building after the event.

toDisplayString

default String toDisplayString()

Description copied from interface: IColonyEventDescription

Builds the string to show in the colony events list.

Specified by:

toDisplayString in interface IColonyEventDescription

Returns:

the string to show in the colony events list.