Package io.papermc.paper.event.entity

Class EntityFertilizeEggEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.entity.EntityEvent

io.papermc.paper.event.entity.EntityFertilizeEggEvent

All Implemented Interfaces:

Cancellable

public class EntityFertilizeEggEvent
extends EntityEvent
implements Cancellable

Called when two entities mate and the mating process results in a fertilization. Fertilization differs from normal breeding, as represented by the EntityBreedEvent, as it does not result in the immediate creation of the child entity in the world.

An example of this would be:

• A frog being marked as "is_pregnant" and laying Material.FROGSPAWN later.
• Sniffers producing the Material.SNIFFER_EGG item, which needs to be placed before it can begin to hatch.
• A turtle being marked with "HasEgg" and laying a Material.TURTLE_EGG later.

The event hence only exposes the two parent entities in the fertilization process and cannot provide the child entity, as it will only exist at a later point in time.

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Field Summary

Fields inherited from class org.bukkit.event.entity.EntityEvent

entity

Constructor Summary

Constructors

Constructor	Description
EntityFertilizeEggEvent(@NotNull LivingEntity mother, @NotNull LivingEntity father, @Nullable Player breeder, @Nullable ItemStack bredWith, int experience)

Method Summary

Modifier and Type	Method	Description
@Nullable ItemStack	getBredWith()	The ItemStack that was used to initiate fertilization, if present.
@Nullable Player	getBreeder()	Gets the Entity responsible for fertilization.
@NotNull LivingEntity	getEntity()	Returns the Entity involved in this event
int	getExperience()	Get the amount of experience granted by fertilization.
@NotNull LivingEntity	getFather()	Provides the "father" entity in the fertilization process that is not responsible for initiating the offspring creation.
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
@NotNull LivingEntity	getMother()	Provides the entity in the fertilization process that will eventually be responsible for "creating" offspring, may that be by setting a block that later hatches or dropping an egg that has to be placed.
boolean	isCancelled()	Gets the cancellation state of this event.
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.
void	setExperience(int experience)	Set the amount of experience granted by fertilization.

Methods inherited from class org.bukkit.event.entity.EntityEvent

getEntityType

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

EntityFertilizeEggEvent

@Internal
public EntityFertilizeEggEvent(@NotNull
 @NotNull LivingEntity mother,
 @NotNull
 @NotNull LivingEntity father,
 @Nullable
 @Nullable Player breeder,
 @Nullable
 @Nullable ItemStack bredWith,
 int experience)

Method Details

getEntity

@NotNull
public @NotNull LivingEntity getEntity()

Description copied from class: EntityEvent

Returns the Entity involved in this event

Overrides:

getEntity in class EntityEvent

Returns:

Entity who is involved in this event

getMother

@NotNull
public @NotNull LivingEntity getMother()

Provides the entity in the fertilization process that will eventually be responsible for "creating" offspring, may that be by setting a block that later hatches or dropping an egg that has to be placed.

Returns:

The "mother" entity.

getFather

@NotNull
public @NotNull LivingEntity getFather()

Provides the "father" entity in the fertilization process that is not responsible for initiating the offspring creation.

Returns:

the other parent

getBreeder

@Nullable
public @Nullable Player getBreeder()

Gets the Entity responsible for fertilization. Breeder is null for spontaneous conception.

Returns:

The Entity who initiated fertilization.

getBredWith

@Nullable
public @Nullable ItemStack getBredWith()

The ItemStack that was used to initiate fertilization, if present.

Returns:

ItemStack used to initiate fertilization.

getExperience

public int getExperience()

Get the amount of experience granted by fertilization.

Returns:

experience amount

setExperience

public void setExperience(int experience)

Set the amount of experience granted by fertilization. If the amount is negative or zero, no experience will be dropped.

Parameters:

experience - experience amount

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

Specified by:

isCancelled in interface Cancellable

Returns:

true if this event is cancelled

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - true if you wish to cancel this event

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()