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

Interface ICitizenEventDescription

All Superinterfaces:

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

All Known Implementing Classes:

AbstractCitizenEvent, CitizenBornEvent, CitizenDiedEvent, CitizenGrownUpEvent, CitizenSpawnedEvent, VisitorSpawnedEvent

public interface ICitizenEventDescription
extends IColonyEventDescription

Event description for citizen spawn/death events.

Method Summary

Modifier and Type	Method	Description
String	getCitizenName()	Gets the name of the citizen causing this event.
void	setCitizenName(String name)	Sets the name of the citizen causing this 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, getEventPos, getEventTypeId, getName, serialize, setEventPos

Methods inherited from interface net.neoforged.neoforge.common.util.INBTSerializable

deserializeNBT, serializeNBT

Method Details

getCitizenName

String getCitizenName()

Gets the name of the citizen causing this event.

Returns:

the name of the citizen causing this event.

setCitizenName

void setCitizenName(String name)

Sets the name of the citizen causing this event.

Parameters:

name - the name of the citizen causing this 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.