SPIGOT-4590, SPIGOT-6769: Clarify DamageCause documentation

By: Doc <nachito94@msn.com>
This commit is contained in:
Bukkit/Spigot 2021-10-27 18:36:29 +11:00
parent 567948a8d1
commit 283a637a66

View file

@ -260,9 +260,10 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable {
public enum DamageCause { public enum DamageCause {
/** /**
* Damage caused when an entity contacts a block such as a Cactus. * Damage caused when an entity contacts a block such as a Cactus,
* Dripstone (Stalagmite) or Berry Bush.
* <p> * <p>
* Damage: 1 (Cactus) * Damage: variable
*/ */
CONTACT, CONTACT,
/** /**
@ -351,9 +352,12 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable {
*/ */
LIGHTNING, LIGHTNING,
/** /**
* Damage caused by committing suicide using the command "/kill" * Damage caused by committing suicide.
* <p> * <p>
* Damage: 1000 * <b>Note:</b> This is currently only used by plugins, default commands
* like /minecraft:kill use {@link #VOID} to damage players.
* <p>
* Damage: variable
*/ */
SUICIDE, SUICIDE,
/** /**