Paper/patches/api/0404-Add-EntityFertilizeEggEvent.patch

152 lines
4.8 KiB
Diff
Raw Normal View History

2023-03-04 23:23:32 +01:00
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Lulu13022002 <41980282+Lulu13022002@users.noreply.github.com>
Date: Fri, 24 Jun 2022 11:56:32 +0200
Subject: [PATCH] Add EntityFertilizeEggEvent
diff --git a/src/main/java/io/papermc/paper/event/entity/EntityFertilizeEggEvent.java b/src/main/java/io/papermc/paper/event/entity/EntityFertilizeEggEvent.java
new file mode 100644
2024-02-01 10:15:57 +01:00
index 0000000000000000000000000000000000000000..35d54650c53bc64dd7c440240ad2f2b9b87d7ae8
2023-03-04 23:23:32 +01:00
--- /dev/null
+++ b/src/main/java/io/papermc/paper/event/entity/EntityFertilizeEggEvent.java
2024-02-01 10:15:57 +01:00
@@ -0,0 +1,139 @@
2023-03-04 23:23:32 +01:00
+package io.papermc.paper.event.entity;
+
2024-02-01 10:15:57 +01:00
+import org.bukkit.Material;
2023-03-04 23:23:32 +01:00
+import org.bukkit.entity.LivingEntity;
+import org.bukkit.entity.Player;
+import org.bukkit.event.Cancellable;
+import org.bukkit.event.HandlerList;
2024-02-01 10:15:57 +01:00
+import org.bukkit.event.entity.EntityBreedEvent;
2023-03-04 23:23:32 +01:00
+import org.bukkit.event.entity.EntityEvent;
+import org.bukkit.inventory.ItemStack;
2024-02-01 10:15:57 +01:00
+import org.jetbrains.annotations.ApiStatus;
2023-03-04 23:23:32 +01:00
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * Called when two entities mate and the mating process results in a fertilization.
2024-02-01 10:15:57 +01:00
+ * Fertilization differs from normal breeding, as represented by the {@link EntityBreedEvent}, as
+ * it does not result in the immediate creation of the child entity in the world.
+ * <p>
+ * An example of this would be:
+ * <ul>
2024-02-01 10:15:57 +01:00
+ * <li>A frog being marked as "is_pregnant" and laying {@link Material#FROGSPAWN} later.</li>
+ * <li>Sniffers producing the {@link Material#SNIFFER_EGG} item, which needs to be placed before it can begin to hatch.</li>
+ * <li>A turtle being marked with "HasEgg" and laying a {@link Material#TURTLE_EGG} later.</li>
+ * </ul>
+ *
+ * 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.
2023-03-04 23:23:32 +01:00
+ */
+public class EntityFertilizeEggEvent extends EntityEvent implements Cancellable {
+
+ private static final HandlerList HANDLER_LIST = new HandlerList();
+
+ private final LivingEntity mother;
+ private final LivingEntity father;
+ private final Player breeder;
+ private final ItemStack bredWith;
+ private int experience;
+
2024-02-01 10:15:57 +01:00
+ private boolean cancelled;
2023-03-04 23:23:32 +01:00
+
2024-02-01 10:15:57 +01:00
+ @ApiStatus.Internal
2023-03-04 23:23:32 +01:00
+ public EntityFertilizeEggEvent(@NotNull LivingEntity mother, @NotNull LivingEntity father, @Nullable Player breeder, @Nullable ItemStack bredWith, int experience) {
+ super(mother);
+ this.mother = mother;
+ this.father = father;
+ this.breeder = breeder;
+ this.bredWith = bredWith;
+ this.experience = experience;
+ }
+
+ @NotNull
+ @Override
+ public LivingEntity getEntity() {
2024-02-01 10:15:57 +01:00
+ return (LivingEntity) super.getEntity();
2023-03-04 23:23:32 +01:00
+ }
+
+ /**
+ * 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.
2023-03-04 23:23:32 +01:00
+ *
+ * @return The "mother" entity.
2023-03-04 23:23:32 +01:00
+ */
+ @NotNull
+ public LivingEntity getMother() {
2024-02-01 10:15:57 +01:00
+ return this.mother;
2023-03-04 23:23:32 +01:00
+ }
+
+ /**
+ * Provides the "father" entity in the fertilization process that is not responsible for initiating the offspring
+ * creation.
2023-03-04 23:23:32 +01:00
+ *
+ * @return the other parent
+ */
+ @NotNull
+ public LivingEntity getFather() {
2024-02-01 10:15:57 +01:00
+ return this.father;
2023-03-04 23:23:32 +01:00
+ }
+
+ /**
2024-02-01 10:15:57 +01:00
+ * Gets the Entity responsible for fertilization. Breeder is {@code null} for spontaneous
2023-03-04 23:23:32 +01:00
+ * conception.
+ *
2024-02-01 10:15:57 +01:00
+ * @return The Entity who initiated fertilization.
2023-03-04 23:23:32 +01:00
+ */
+ @Nullable
+ public Player getBreeder() {
2024-02-01 10:15:57 +01:00
+ return this.breeder;
2023-03-04 23:23:32 +01:00
+ }
+
+ /**
+ * The ItemStack that was used to initiate fertilization, if present.
+ *
2024-02-01 10:15:57 +01:00
+ * @return ItemStack used to initiate fertilization.
2023-03-04 23:23:32 +01:00
+ */
+ @Nullable
+ public ItemStack getBredWith() {
2024-02-01 10:15:57 +01:00
+ return this.bredWith;
2023-03-04 23:23:32 +01:00
+ }
+
+ /**
+ * Get the amount of experience granted by fertilization.
+ *
+ * @return experience amount
+ */
+ public int getExperience() {
2024-02-01 10:15:57 +01:00
+ return this.experience;
2023-03-04 23:23:32 +01:00
+ }
+
+ /**
+ * Set the amount of experience granted by fertilization.
+ * If the amount is negative or zero, no experience will be dropped.
+ *
+ * @param experience experience amount
+ */
+ public void setExperience(int experience) {
+ this.experience = experience;
+ }
+
+ @Override
+ public boolean isCancelled() {
2024-02-01 10:15:57 +01:00
+ return this.cancelled;
2023-03-04 23:23:32 +01:00
+ }
+
+ @Override
+ public void setCancelled(boolean cancel) {
2024-02-01 10:15:57 +01:00
+ this.cancelled = cancel;
2023-03-04 23:23:32 +01:00
+ }
+
+ @NotNull
+ @Override
+ public HandlerList getHandlers() {
+ return HANDLER_LIST;
+ }
+
+ @NotNull
+ public static HandlerList getHandlerList() {
+ return HANDLER_LIST;
+ }
+}