Upstream/Minestom
1
0
Fork 0
mirror of https://github.com/Minestom/Minestom.git synced 2025-01-21 23:51:36 +01:00
Code Issues Projects Releases Wiki Activity

Add javadocs for Potion (#1763)

Browse Source
This commit is contained in:
Zak Shearman 2023-02-26 17:55:34 +00:00 committed by GitHub
parent aebf72de90
commit a9e319f961
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/main/java/net/minestom/server/potion/Potion.java
View File

@ -11,6 +11,14 @@ import java.util.Objects;
import static net.minestom.server.network.NetworkBuffer.BYTE; import static net.minestom.server.network.NetworkBuffer.BYTE;
import static net.minestom.server.network.NetworkBuffer.VAR_INT; import static net.minestom.server.network.NetworkBuffer.VAR_INT;
/**
* Represents a potion effect that can be added to an {@link net.minestom.server.entity.Entity}.
*
* @param effect the potion effect
* @param amplifier the amplifier starting at 0 (level 1)
* @param duration the duration (in ticks) that the potion will last
* @param flags the flags of the potion, see {@link #flags()}
*/
public record Potion(@NotNull PotionEffect effect, byte amplifier, public record Potion(@NotNull PotionEffect effect, byte amplifier,
int duration, byte flags) implements NetworkBuffer.Writer { int duration, byte flags) implements NetworkBuffer.Writer {
/** /**
@ -40,6 +48,11 @@ public record Potion(@NotNull PotionEffect effect, byte amplifier,
*/ */
public static final byte ICON_FLAG = 0x04; public static final byte ICON_FLAG = 0x04;
/**
* Creates a new Potion with no flags.
*
* @see #Potion(PotionEffect, byte, int, byte)
*/
public Potion(@NotNull PotionEffect effect, byte amplifier, int duration) { public Potion(@NotNull PotionEffect effect, byte amplifier, int duration) {
this(effect, amplifier, duration, (byte) 0); this(effect, amplifier, duration, (byte) 0);
} }