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

Class CitizenSpawnedEvent

java.lang.Object

com.minecolonies.core.colony.eventhooks.AbstractEvent

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

com.minecolonies.core.colony.eventhooks.citizenEvents.CitizenSpawnedEvent

All Implemented Interfaces:

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

public class CitizenSpawnedEvent
extends AbstractCitizenEvent

The event handling a newly spawned(not born) citizen.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
CitizenSpawnedEvent()	Creates a new citizen spawned event.
CitizenSpawnedEvent(net.minecraft.core.BlockPos eventPos, String citizenName)	Creates a new citizen spawned 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 CitizenSpawnedEvent	loadFromFriendlyByteBuf(@NotNull net.minecraft.network.FriendlyByteBuf buf)	Loads the citizen spawned event from the given packet buffer.
static CitizenSpawnedEvent	loadFromNBT(@NotNull net.minecraft.nbt.CompoundTag compound)	Loads the citizen spawned 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 com.minecolonies.core.colony.eventhooks.AbstractEvent

getDay, includeInSummary, setDay

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

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

getDay, getSummaryTranslationKey, includeInSummary, setDay

Field Details

CITIZEN_SPAWNED_EVENT_ID

public static final net.minecraft.resources.ResourceLocation CITIZEN_SPAWNED_EVENT_ID

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

Constructor Details

CitizenSpawnedEvent

public CitizenSpawnedEvent()

Creates a new citizen spawned event.

CitizenSpawnedEvent

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

Creates a new citizen spawned 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 CitizenSpawnedEvent loadFromNBT(@NotNull
 @NotNull net.minecraft.nbt.CompoundTag compound)

Loads the citizen spawned event from the given nbt.

Parameters:

compound - the NBT compound

Returns:

the colony to load.

loadFromFriendlyByteBuf

public static CitizenSpawnedEvent loadFromFriendlyByteBuf(@NotNull
 @NotNull net.minecraft.network.FriendlyByteBuf buf)

Loads the citizen spawned event from the given packet buffer.

Parameters:

buf - the packet buffer.

Returns:

the colony to load.