Package com.minecolonies.core.colony.eventhooks.citizenEvents

Class CitizenBornEvent

java.lang.Object

com.minecolonies.core.colony.eventhooks.citizenEvents.AbstractCitizenEvent

com.minecolonies.core.colony.eventhooks.citizenEvents.CitizenBornEvent

All Implemented Interfaces:

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

public class CitizenBornEvent
extends AbstractCitizenEvent

The event for handling a newly born citizen.

Field Summary

Fields

Modifier and Type	Field	Description
static final net.minecraft.resources.ResourceLocation	CITIZEN_BORN_EVENT_ID	This events id, registry entries use res locations as ids.

Constructor Summary

Constructors

Constructor	Description
CitizenBornEvent()	Creates a new citizen born event.
CitizenBornEvent(net.minecraft.core.BlockPos eventPos, String citizenName)	Creates a new citizen born event.

Method Summary

Modifier and Type	Method	Description
net.minecraft.resources.ResourceLocation	getEventTypeId()	Gets this event types registry id.
String	getName()	Gets the name of this event type.
static CitizenBornEvent	loadFromFriendlyByteBuf(@NotNull net.minecraft.network.RegistryFriendlyByteBuf buf)	Loads the citizen born event from the given packet buffer.
static CitizenBornEvent	loadFromNBT(net.minecraft.core.HolderLookup.Provider provider, @NotNull net.minecraft.nbt.CompoundTag compound)	Loads the citizen born event from the given nbt.

Methods inherited from class com.minecolonies.core.colony.eventhooks.citizenEvents.AbstractCitizenEvent

deserialize, deserializeNBT, getCitizenName, getEventPos, serialize, serializeNBT, setCitizenName, setEventPos, toString

Methods inherited from class java.lang.Object

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

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

toDisplayString

Field Details

CITIZEN_BORN_EVENT_ID

public static final net.minecraft.resources.ResourceLocation CITIZEN_BORN_EVENT_ID

This events id, registry entries use res locations as ids.

Constructor Details

CitizenBornEvent

public CitizenBornEvent()

Creates a new citizen born event.

CitizenBornEvent

public CitizenBornEvent(net.minecraft.core.BlockPos eventPos,
 String citizenName)

Creates a new citizen born event.

Parameters:

eventPos - the position of the hut block of the building.

citizenName - the name of the building.

Method Details

getEventTypeId

public net.minecraft.resources.ResourceLocation getEventTypeId()

Description copied from interface: IColonyEventDescription

Gets this event types registry id.

Returns:

this event types registry id.

getName

public String getName()

Description copied from interface: IColonyEventDescription

Gets the name of this event type.

Returns:

the name of this event type.

loadFromNBT

public static CitizenBornEvent loadFromNBT(@NotNull
 net.minecraft.core.HolderLookup.Provider provider,
 @NotNull
 @NotNull net.minecraft.nbt.CompoundTag compound)

Loads the citizen born event from the given nbt.

Parameters:

compound - the NBT compound

Returns:

the colony to load.

loadFromFriendlyByteBuf

public static CitizenBornEvent loadFromFriendlyByteBuf(@NotNull
 @NotNull net.minecraft.network.RegistryFriendlyByteBuf buf)

Loads the citizen born event from the given packet buffer.

Parameters:

buf - the packet buffer.

Returns:

the colony to load.