Upstream/Paper
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-01-03 23:07:40 +01:00
Code Issues Projects Releases Wiki Activity

#684: Make PotionEffectType implement Keyed

Browse Source 
By: coll1234567 <joshl5324@gmail.com>
This commit is contained in:
Bukkit/Spigot 2021-11-28 11:49:39 +11:00
parent c7d5155340
commit 45f7e75b02
2 changed files with 63 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
paper-api/src/main/java/org/bukkit/potion/PotionEffectType.java
View File

@ -5,179 +5,184 @@ import java.util.HashMap;
import java.util.Map; import java.util.Map;
import org.apache.commons.lang.Validate; import org.apache.commons.lang.Validate;
import org.bukkit.Color; import org.bukkit.Color;
import org.bukkit.Keyed;
import org.bukkit.NamespacedKey;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable; import org.jetbrains.annotations.Nullable;
/** /**
* Represents a type of potion and its effect on an entity. * Represents a type of potion and its effect on an entity.
*/ */
public abstract class PotionEffectType { public abstract class PotionEffectType implements Keyed {
/** /**
* Increases movement speed. * Increases movement speed.
*/ */
public static final PotionEffectType SPEED = new PotionEffectTypeWrapper(1); public static final PotionEffectType SPEED = new PotionEffectTypeWrapper(1, "speed");
/** /**
* Decreases movement speed. * Decreases movement speed.
*/ */
public static final PotionEffectType SLOW = new PotionEffectTypeWrapper(2); public static final PotionEffectType SLOW = new PotionEffectTypeWrapper(2, "slowness");
/** /**
* Increases dig speed. * Increases dig speed.
*/ */
public static final PotionEffectType FAST_DIGGING = new PotionEffectTypeWrapper(3); public static final PotionEffectType FAST_DIGGING = new PotionEffectTypeWrapper(3, "haste");
/** /**
* Decreases dig speed. * Decreases dig speed.
*/ */
public static final PotionEffectType SLOW_DIGGING = new PotionEffectTypeWrapper(4); public static final PotionEffectType SLOW_DIGGING = new PotionEffectTypeWrapper(4, "mining_fatigue");
/** /**
* Increases damage dealt. * Increases damage dealt.
*/ */
public static final PotionEffectType INCREASE_DAMAGE = new PotionEffectTypeWrapper(5); public static final PotionEffectType INCREASE_DAMAGE = new PotionEffectTypeWrapper(5, "strength");
/** /**
* Heals an entity. * Heals an entity.
*/ */
public static final PotionEffectType HEAL = new PotionEffectTypeWrapper(6); public static final PotionEffectType HEAL = new PotionEffectTypeWrapper(6, "instant_health");
/** /**
* Hurts an entity. * Hurts an entity.
*/ */
public static final PotionEffectType HARM = new PotionEffectTypeWrapper(7); public static final PotionEffectType HARM = new PotionEffectTypeWrapper(7, "instant_damage");
/** /**
* Increases jump height. * Increases jump height.
*/ */
public static final PotionEffectType JUMP = new PotionEffectTypeWrapper(8); public static final PotionEffectType JUMP = new PotionEffectTypeWrapper(8, "jump_boost");
/** /**
* Warps vision on the client. * Warps vision on the client.
*/ */
public static final PotionEffectType CONFUSION = new PotionEffectTypeWrapper(9); public static final PotionEffectType CONFUSION = new PotionEffectTypeWrapper(9, "nausea");
/** /**
* Regenerates health. * Regenerates health.
*/ */
public static final PotionEffectType REGENERATION = new PotionEffectTypeWrapper(10); public static final PotionEffectType REGENERATION = new PotionEffectTypeWrapper(10, "regeneration");
/** /**
* Decreases damage dealt to an entity. * Decreases damage dealt to an entity.
*/ */
public static final PotionEffectType DAMAGE_RESISTANCE = new PotionEffectTypeWrapper(11); public static final PotionEffectType DAMAGE_RESISTANCE = new PotionEffectTypeWrapper(11, "resistance");
/** /**
* Stops fire damage. * Stops fire damage.
*/ */
public static final PotionEffectType FIRE_RESISTANCE = new PotionEffectTypeWrapper(12); public static final PotionEffectType FIRE_RESISTANCE = new PotionEffectTypeWrapper(12, "fire_resistance");
/** /**
* Allows breathing underwater. * Allows breathing underwater.
*/ */
public static final PotionEffectType WATER_BREATHING = new PotionEffectTypeWrapper(13); public static final PotionEffectType WATER_BREATHING = new PotionEffectTypeWrapper(13, "water_breathing");
/** /**
* Grants invisibility. * Grants invisibility.
*/ */
public static final PotionEffectType INVISIBILITY = new PotionEffectTypeWrapper(14); public static final PotionEffectType INVISIBILITY = new PotionEffectTypeWrapper(14, "invisibility");
/** /**
* Blinds an entity. * Blinds an entity.
*/ */
public static final PotionEffectType BLINDNESS = new PotionEffectTypeWrapper(15); public static final PotionEffectType BLINDNESS = new PotionEffectTypeWrapper(15, "blindness");
/** /**
* Allows an entity to see in the dark. * Allows an entity to see in the dark.
*/ */
public static final PotionEffectType NIGHT_VISION = new PotionEffectTypeWrapper(16); public static final PotionEffectType NIGHT_VISION = new PotionEffectTypeWrapper(16, "night_vision");
/** /**
* Increases hunger. * Increases hunger.
*/ */
public static final PotionEffectType HUNGER = new PotionEffectTypeWrapper(17); public static final PotionEffectType HUNGER = new PotionEffectTypeWrapper(17, "hunger");
/** /**
* Decreases damage dealt by an entity. * Decreases damage dealt by an entity.
*/ */
public static final PotionEffectType WEAKNESS = new PotionEffectTypeWrapper(18); public static final PotionEffectType WEAKNESS = new PotionEffectTypeWrapper(18, "weakness");
/** /**
* Deals damage to an entity over time. * Deals damage to an entity over time.
*/ */
public static final PotionEffectType POISON = new PotionEffectTypeWrapper(19); public static final PotionEffectType POISON = new PotionEffectTypeWrapper(19, "poison");
/** /**
* Deals damage to an entity over time and gives the health to the * Deals damage to an entity over time and gives the health to the
* shooter. * shooter.
*/ */
public static final PotionEffectType WITHER = new PotionEffectTypeWrapper(20); public static final PotionEffectType WITHER = new PotionEffectTypeWrapper(20, "wither");
/** /**
* Increases the maximum health of an entity. * Increases the maximum health of an entity.
*/ */
public static final PotionEffectType HEALTH_BOOST = new PotionEffectTypeWrapper(21); public static final PotionEffectType HEALTH_BOOST = new PotionEffectTypeWrapper(21, "health_boost");
/** /**
* Increases the maximum health of an entity with health that cannot be * Increases the maximum health of an entity with health that cannot be
* regenerated, but is refilled every 30 seconds. * regenerated, but is refilled every 30 seconds.
*/ */
public static final PotionEffectType ABSORPTION = new PotionEffectTypeWrapper(22); public static final PotionEffectType ABSORPTION = new PotionEffectTypeWrapper(22, "absorption");
/** /**
* Increases the food level of an entity each tick. * Increases the food level of an entity each tick.
*/ */
public static final PotionEffectType SATURATION = new PotionEffectTypeWrapper(23); public static final PotionEffectType SATURATION = new PotionEffectTypeWrapper(23, "saturation");
/** /**
* Outlines the entity so that it can be seen from afar. * Outlines the entity so that it can be seen from afar.
*/ */
public static final PotionEffectType GLOWING = new PotionEffectTypeWrapper(24); public static final PotionEffectType GLOWING = new PotionEffectTypeWrapper(24, "glowing");
/** /**
* Causes the entity to float into the air. * Causes the entity to float into the air.
*/ */
public static final PotionEffectType LEVITATION = new PotionEffectTypeWrapper(25); public static final PotionEffectType LEVITATION = new PotionEffectTypeWrapper(25, "levitation");
/** /**
* Loot table luck. * Loot table luck.
*/ */
public static final PotionEffectType LUCK = new PotionEffectTypeWrapper(26); public static final PotionEffectType LUCK = new PotionEffectTypeWrapper(26, "luck");
/** /**
* Loot table unluck. * Loot table unluck.
*/ */
public static final PotionEffectType UNLUCK = new PotionEffectTypeWrapper(27); public static final PotionEffectType UNLUCK = new PotionEffectTypeWrapper(27, "unluck");
/** /**
* Slows entity fall rate. * Slows entity fall rate.
*/ */
public static final PotionEffectType SLOW_FALLING = new PotionEffectTypeWrapper(28); public static final PotionEffectType SLOW_FALLING = new PotionEffectTypeWrapper(28, "slow_falling");
/** /**
* Effects granted by a nearby conduit. Includes enhanced underwater abilities. * Effects granted by a nearby conduit. Includes enhanced underwater abilities.
*/ */
public static final PotionEffectType CONDUIT_POWER = new PotionEffectTypeWrapper(29); public static final PotionEffectType CONDUIT_POWER = new PotionEffectTypeWrapper(29, "conduit_power");
/** /**
* Squee'ek uh'k kk'kkkk squeek eee'eek. * Squee'ek uh'k kk'kkkk squeek eee'eek.
*/ */
public static final PotionEffectType DOLPHINS_GRACE = new PotionEffectTypeWrapper(30); public static final PotionEffectType DOLPHINS_GRACE = new PotionEffectTypeWrapper(30, "dolphins_grace");
/** /**
* oof. * oof.
*/ */
public static final PotionEffectType BAD_OMEN = new PotionEffectTypeWrapper(31); public static final PotionEffectType BAD_OMEN = new PotionEffectTypeWrapper(31, "bad_omen");
/** /**
* \o/. * \o/.
*/ */
public static final PotionEffectType HERO_OF_THE_VILLAGE = new PotionEffectTypeWrapper(32); public static final PotionEffectType HERO_OF_THE_VILLAGE = new PotionEffectTypeWrapper(32, "hero_of_the_village");
private final int id; private final int id;
private final NamespacedKey key;
protected PotionEffectType(int id) { protected PotionEffectType(int id, @NotNull NamespacedKey key) {
this.id = id; this.id = id;
this.key = key;
} }
/** /**
@ -214,6 +219,12 @@ public abstract class PotionEffectType {
return id; return id;
} }
@NotNull
@Override
public NamespacedKey getKey() {
return key;
}
/** /**
* Returns the name of this effect type. * Returns the name of this effect type.
* *
@ -264,9 +275,22 @@ public abstract class PotionEffectType {
private static final PotionEffectType[] byId = new PotionEffectType[33]; private static final PotionEffectType[] byId = new PotionEffectType[33];
private static final Map<String, PotionEffectType> byName = new HashMap<String, PotionEffectType>(); private static final Map<String, PotionEffectType> byName = new HashMap<String, PotionEffectType>();
private static final Map<NamespacedKey, PotionEffectType> byKey = new HashMap<NamespacedKey, PotionEffectType>();
// will break on updates. // will break on updates.
private static boolean acceptingNew = true; private static boolean acceptingNew = true;
/**
* Gets the PotionEffectType at the specified key
*
* @param key key to fetch
* @return Resulting PotionEffectType, or null if not found
*/
@Contract("null -> null")
@Nullable
public static PotionEffectType getByKey(@Nullable NamespacedKey key) {
return byKey.get(key);
}
/** /**
* Gets the effect type specified by the unique id. * Gets the effect type specified by the unique id.
* *
@ -302,7 +326,7 @@ public abstract class PotionEffectType {
* @param type PotionType to register * @param type PotionType to register
*/ */
public static void registerPotionEffectType(@NotNull PotionEffectType type) { public static void registerPotionEffectType(@NotNull PotionEffectType type) {
if (byId[type.id] != null || byName.containsKey(type.getName().toLowerCase(java.util.Locale.ENGLISH))) { if (byId[type.id] != null || byName.containsKey(type.getName().toLowerCase(java.util.Locale.ENGLISH)) || byKey.containsKey(type.key)) {
throw new IllegalArgumentException("Cannot set already-set type"); throw new IllegalArgumentException("Cannot set already-set type");
} else if (!acceptingNew) { } else if (!acceptingNew) {
throw new IllegalStateException( throw new IllegalStateException(
@ -311,6 +335,7 @@ public abstract class PotionEffectType {
byId[type.id] = type; byId[type.id] = type;
byName.put(type.getName().toLowerCase(java.util.Locale.ENGLISH), type); byName.put(type.getName().toLowerCase(java.util.Locale.ENGLISH), type);
byKey.put(type.key, type);
} }
/** /**

5
paper-api/src/main/java/org/bukkit/potion/PotionEffectTypeWrapper.java
View File

@ -1,11 +1,12 @@
package org.bukkit.potion; package org.bukkit.potion;
import org.bukkit.Color; import org.bukkit.Color;
import org.bukkit.NamespacedKey;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
public class PotionEffectTypeWrapper extends PotionEffectType { public class PotionEffectTypeWrapper extends PotionEffectType {
protected PotionEffectTypeWrapper(int id) { protected PotionEffectTypeWrapper(int id, @NotNull String name) {
super(id); super(id, NamespacedKey.minecraft(name));
} }
@Override @Override