Y2K_ / Bukkit2 / ab74003f431

Commits

Mikołaj Nowak authored and md_5 committed ab74003f431 31 Dec 2024

SPIGOT-5784, SPIGOT-6858, #1089: Add villager reputation API

src/main/java/org/bukkit/entity/Villager.java

Modified

-1
+package org.bukkit.entity;
-2
-3
+import com.google.common.base.Preconditions;
-4
+import com.google.common.collect.Lists;
-5
+import java.util.Locale;
-+
+import java.util.UUID;
-+
+import org.bukkit.Bukkit;
-8
+import org.bukkit.Keyed;
-9
+import org.bukkit.Location;
-10
+import org.bukkit.NamespacedKey;
-11
+import org.bukkit.Registry;
-12
+import org.bukkit.util.OldEnum;
-13
+import org.jetbrains.annotations.NotNull;
-14
+import org.jetbrains.annotations.Nullable;
-15
-16
+/**
-17
+ * Represents a villager NPC
-113
+     * Zombie.
-114
+     *
-115
+     * <b>Note:</b> this will fire a EntityTransformEvent
-116
+     *
-117
+     * @return the converted entity {@link ZombieVillager} or null if the
-118
+     * conversion its cancelled
-119
+     */
-120
+    @Nullable
-121
+    public ZombieVillager zombify();
-122
-+
+    /**
-+
+     * Gets the reputation of an entity for a given type.
-+
+     *
-+
+     * @param uuid the UUID of the entity whose reputation is being checked
-+
+     * @param reputationType reputation type to be retrieved
-+
+     * @return current reputation for the given reputation type
-+
+     */
-+
+    public int getReputation(@NotNull UUID uuid, @NotNull ReputationType reputationType);
-+
-+
+    /**
-+
+     * Gets the weighted reputation of an entity for a given type.
-+
+     *
-+
+     * <p>The total reputation of an entity is a sum of its weighted
-+
+     * reputations of each type, where the reputation is multiplied by weight
-+
+     * assigned to its type.
-+
+     *
-+
+     * @param uuid the UUID of the entity whose reputation is being checked
-+
+     * @param reputationType reputation type to be retrieved
-+
+     * @return current reputation for the given reputation type
-+
+     * @see ReputationType#getWeight()
-+
+     */
-+
+    public int getWeightedReputation(@NotNull UUID uuid, @NotNull ReputationType reputationType);
-+
-+
+    /**
-+
+     * Gets the reputation of an entity.
-+
+     *
-+
+     * @param uuid the UUID of the entity whose reputation is being checked
-+
+     * @return current reputation for the given reputation type
-+
+     */
-+
+    public int getReputation(@NotNull UUID uuid);
-+
-+
+    /**
-+
+     * Add reputation of a given type towards a given entity.
-+
+     *
-+
+     * <p>The final value will be clamped to the maximum value supported by the
-+
+     * provided reputation type. If the final value is below the reputation
-+
+     * discard threshold, gossip associated with this reputation type will be
-+
+     * removed.
-+
+     *
-+
+     * <p>Note: this will fire a
-+
+     * {@link org.bukkit.event.entity.VillagerReputationChangeEvent}.
-+
+     *
-+
+     * @param uuid the UUID of the entity for whom the reputation is being
-+
+     *             added
-+
+     * @param reputationType reputation type to be modified
-+
+     * @param amount amount of reputation to add
-+
+     */
-+
+    public void addReputation(@NotNull UUID uuid, @NotNull ReputationType reputationType, int amount);
-+
-+
+    /**
-+
+     * Add reputation of a given type towards a given entity, with a specific
-+
+     * change reason.
-+
+     *
-+
+     * <p>The final value will be clamped to the maximum value supported by the
-+
+     * provided reputation type. If the final value is below the reputation
-+
+     * discard threshold, gossip associated with this reputation type will be
-+
+     * removed.
-+
+     *
-+
+     * <p>Note: this will fire a
-+
+     * {@link org.bukkit.event.entity.VillagerReputationChangeEvent}.
-+
+     *
-+
+     * @param uuid the UUID of the entity for whom the reputation is being
-+
+     *             added
-+
+     * @param reputationType reputation type to be modified
-+
+     * @param amount amount of reputation to add
-+
+     * @param changeReason reputation change reason
-+
+     */
-+
+    public void addReputation(@NotNull UUID uuid, @NotNull ReputationType reputationType, int amount, @NotNull ReputationEvent changeReason);
-+
-+
+    /**
-+
+     * Remove reputation of a given type towards a given entity.
-+
+     *
-+
+     * <p>The final value will be clamped to the maximum value supported by the
-+
+     * provided reputation type. If the final value is below the reputation
-+
+     * discard threshold, gossip associated with this reputation type will be
-+
+     * removed.
-+
+     *
-+
+     * <p>Note: this will fire a
-+
+     * {@link org.bukkit.event.entity.VillagerReputationChangeEvent}.
-+
+     *
-+
+     * @param uuid the UUID of the entity for whom the reputation is being
-+
+     *             removed
-+
+     * @param reputationType reputation type to be modified
-+
+     * @param amount amount of reputation to remove
-+
+     */
-+
+    public void removeReputation(@NotNull UUID uuid, @NotNull ReputationType reputationType, int amount);
-+
-+
+    /**
-+
+     * Remove reputation of a given type towards a given entity, with a
-+
+     * specific change reason.
-+
+     *
-+
+     * <p>The final value will be clamped to the maximum value supported by the
-+
+     * provided reputation type. If the final value is below the reputation
-+
+     * discard threshold, gossip associated with this reputation type will be
-+
+     * removed.
-+
+     *
-+
+     * <p>Note: this will fire a
-+
+     * {@link org.bukkit.event.entity.VillagerReputationChangeEvent}.
-+
+     *
-+
+     * @param uuid the UUID of the entity for whom the reputation is being
-+
+     *             removed
-+
+     * @param reputationType reputation type to be modified
-+
+     * @param amount amount of reputation to remove
-+
+     * @param changeReason reputation change reason
-+
+     */
-+
+    public void removeReputation(@NotNull UUID uuid, @NotNull ReputationType reputationType, int amount, @NotNull ReputationEvent changeReason);
-+
-+
+    /**
-+
+     * Set reputation of a given type towards a given entity.
-+
+     *
-+
+     * <p>The final value will be clamped to the maximum value supported by the
-+
+     * provided reputation type. If the final value is below the reputation
-+
+     * discard threshold, gossip associated with this reputation type will be
-+
+     * removed.
-+
+     *
-+
+     * <p>Note: this will fire a
-+
+     * {@link org.bukkit.event.entity.VillagerReputationChangeEvent}.
-+
+     *
-+
+     * @param uuid the UUID of the entity for whom the reputation is being
-+
+     *             added
-+
+     * @param reputationType reputation type to be modified
-+
+     * @param amount amount of reputation to add
-+
+     */
-+
+    public void setReputation(@NotNull UUID uuid, @NotNull ReputationType reputationType, int amount);
-+
-+
+    /**
-+
+     * Set reputation of a given type towards a given entity, with a specific
-+
+     * change reason.
-+
+     *
-+
+     * <p>The final value will be clamped to the maximum value supported by the
-+
+     * provided reputation type. If the final value is below the reputation
-+
+     * discard threshold, gossip associated with this reputation type will be
-+
+     * removed.
-+
+     *
-+
+     * <p>Note: this will fire a
-+
+     * {@link org.bukkit.event.entity.VillagerReputationChangeEvent}.
-+
+     *
-+
+     * @param uuid the UUID of the entity for whom the reputation is being
-+
+     *             added
-+
+     * @param reputationType reputation type to be modified
-+
+     * @param amount amount of reputation to add
-+
+     * @param changeReason reputation change reason
-+
+     */
-+
+    public void setReputation(@NotNull UUID uuid, @NotNull ReputationType reputationType, int amount, @NotNull ReputationEvent changeReason);
-+
-+
+    /**
-+
+     * Sets the reputation decay time for this villager.
-+
+     *
-+
+     * <p>Defaults to <b>24000</b> (1 daylight cycle).
-+
+     *
-+
+     * @param ticks amount of ticks until the villager's reputation decays
-+
+     */
-+
+    public void setGossipDecayTime(long ticks);
-+
-+
+    /**
-+
+     * Gets the reputation decay time for this villager.
-+
+     *
-+
+     * <p>Defaults to <b>24000</b> (1 daylight cycle).
-+
+     *
-+
+     * @return amount of ticks until the villager's reputation decays
-+
+     */
-+
+    public long getGossipDecayTime();
-+
-286
+    /**
-287
+     * Represents Villager type, usually corresponding to what biome they spawn
-288
+     * in.
-289
+     */
-290
+    interface Type extends OldEnum<Type>, Keyed {
-291
-292
+        Type DESERT = getType("desert");
-293
+        Type JUNGLE = getType("jungle");
-294
+        Type PLAINS = getType("plains");
-295
+        Type SAVANNA = getType("savanna");
-425
+        /**
-426
+         * @return an array of all known villager professions.
-427
+         * @deprecated use {@link Registry#iterator()}.
-428
+         */
-429
+        @NotNull
-430
+        @Deprecated(since = "1.21")
-431
+        static Profession[] values() {
-432
+            return Lists.newArrayList(Registry.VILLAGER_PROFESSION).toArray(new Profession[0]);
-433
+        }
-434
+    }
-+
-+
+    /**
-+
+     * Reputation type used in gossips.
-+
+     */
-+
+    interface ReputationType {
-+
-+
+        /**
-+
+         * Major negative reputation. It is caused by killing a villager.
-+
+         */
-+
+        ReputationType MAJOR_NEGATIVE = getReputationType("major_negative");
-+
+        /**
-+
+         * Minor negative reputation. It is caused by attacking a villager.
-+
+         */
-+
+        ReputationType MINOR_NEGATIVE = getReputationType("minor_negative");
-+
+        /**
-+
+         * Minor positive reputation. It is caused by curing a villager.
-+
+         */
-+
+        ReputationType MINOR_POSITIVE = getReputationType("minor_positive");
-+
+        /**
-+
+         * Major positive reputation. It is caused by curing a villager, it is
-+
+         * never shared in gossip and never decays.
-+
+         */
-+
+        ReputationType MAJOR_POSITIVE = getReputationType("major_positive");
-+
+        /**
-+
+         * Trading reputation. It has the same weight as minor positive
-+
+         * reputation and is caused by trading with a villager.
-+
+         */
-+
+        ReputationType TRADING = getReputationType("trading");
-+
-+
+        /**
-+
+         * Get maximum reputation value of this type.
-+
+         * @return maximum value of this reputation type
-+
+         */
-+
+        int getMaxValue();
-+
-+
+        /**
-+
+         * Get weight of this reputation type.
-+
+         *
-+
+         * <p>When calculating total reputation of an entity, reputation of
-+
+         * each type is multiplied by its weight.
-+
+         *
-+
+         * @return weight assigned to this reputation type
-+
+         */
-+
+        int getWeight();
-+
-+
+        private static ReputationType getReputationType(String key) {
-+
+            return Bukkit.getUnsafe().createReputationType(key);
-+
+        }
-+
+    }
-+
-+
+    /**
-+
+     * Reputation change reason.
-+
+     */
-+
+    interface ReputationEvent {
-+
-+
+        /**
-+
+         * A villager was cured by a player.
-+
+         */
-+
+        ReputationEvent ZOMBIE_VILLAGER_CURED = getReputationEvent("zombie_villager_cured");
-+
+        /**
-+
+         * A player traded with a villager.
-+
+         */
-+
+        ReputationEvent TRADE = getReputationEvent("trade");
-+
+        /**
-+
+         * A villager was hurt by an entity.
-+
+         */
-+
+        ReputationEvent VILLAGER_HURT = getReputationEvent("villager_hurt");
-+
+        /**
-+
+         * A villager was killed by an entity.
-+
+         */
-+
+        ReputationEvent VILLAGER_KILLED = getReputationEvent("villager_killed");
-+
+        /**
-+
+         * A villager gossiped with another villager.
-+
+         */
-+
+        ReputationEvent GOSSIP = getReputationEvent("bukkit_gossip");
-+
+        /**
-+
+         * Reputation decayed over time.
-+
+         */
-+
+        ReputationEvent DECAY = getReputationEvent("bukkit_decay");
-+
+        /**
-+
+         * Village's iron golem was killed by an entity.
-+
+         */
-+
+        ReputationEvent GOLEM_KILLED = getReputationEvent("golem_killed");
-+
+        /**
-+
+         * Unspecified reason. Available only by setting the reputation
-+
+         * programmatically.
-+
+         */
-+
+        ReputationEvent UNSPECIFIED = getReputationEvent("bukkit_unspecified");
-+
-+
+        private static ReputationEvent getReputationEvent(String key) {
-+
+            return Bukkit.getUnsafe().createReputationEvent(key);
-+
+        }
-+
+    }
-528
+}

Bukkit2

Commits

Jira Issues

Add shortcut