net.minestom.server.instance.Weather Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of minestom-snapshots Show documentation
1.20.4 Lightweight Minecraft server
There is a newer version: 7320437640
package net.minestom.server.instance;

import it.unimi.dsi.fastutil.floats.FloatUnaryOperator;
import net.minestom.server.network.packet.server.SendablePacket;
import net.minestom.server.network.packet.server.play.ChangeGameStatePacket;
import net.minestom.server.utils.MathUtils;
import net.minestom.server.utils.validate.Check;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;

import java.util.Collection;
import java.util.List;

/**
 * Represents the possible weather properties of an instance
 *
 * @param rainLevel    a percentage between 0 and 1
 *                     used to change how heavy the rain is
 *                     higher values darken the sky and increase rain opacity
 * @param thunderLevel a percentage between 0 and 1
 *                     used to change how heavy the thunder is
 *                     higher values further darken the sky
 */
public record Weather(float rainLevel, float thunderLevel) {
    public static final Weather CLEAR = new Weather(0, 0);
    public static final Weather RAIN = new Weather(1, 0);
    public static final Weather THUNDER = new Weather(1, 1);

    /**
     * @throws IllegalArgumentException if {@code rainLevel} is not between 0 and 1
     * @throws IllegalArgumentException if {@code thunderLevel} is not between 0 and 1
     */
    public Weather {
        Check.argCondition(!MathUtils.isBetween(rainLevel, 0, 1), "Rain level should be between 0 and 1");
        Check.argCondition(!MathUtils.isBetween(thunderLevel, 0, 1), "Thunder level should be between 0 and 1");
    }

    @Contract(pure = true)
    public @NotNull Weather withRainLevel(float rainLevel) {
        return new Weather(rainLevel, thunderLevel);
    }

    /**
     * @return true if {@code rainLevel} is > 0
     */
    public boolean isRaining() {
        return rainLevel > 0;
    }

    @Contract(pure = true)
    public @NotNull Weather withRainLevel(@NotNull FloatUnaryOperator operator) {
        return withRainLevel(operator.apply(rainLevel));
    }

    @Contract(pure = true)
    public @NotNull Weather withThunderLevel(float thunderLevel) {
        return new Weather(rainLevel, thunderLevel);
    }

    @Contract(pure = true)
    public @NotNull Weather withThunderLevel(@NotNull FloatUnaryOperator operator) {
        return withRainLevel(operator.apply(thunderLevel));
    }

    public ChangeGameStatePacket createIsRainingPacket() {
        return new ChangeGameStatePacket(isRaining() ? ChangeGameStatePacket.Reason.BEGIN_RAINING : ChangeGameStatePacket.Reason.END_RAINING, 0);
    }

    public ChangeGameStatePacket createRainLevelPacket() {
        return new ChangeGameStatePacket(ChangeGameStatePacket.Reason.RAIN_LEVEL_CHANGE, rainLevel);
    }

    public ChangeGameStatePacket createThunderLevelPacket() {
        return new ChangeGameStatePacket(ChangeGameStatePacket.Reason.THUNDER_LEVEL_CHANGE, thunderLevel);
    }

    public @NotNull Collection createWeatherPackets() {
        return List.of(createIsRainingPacket(), createRainLevelPacket(), createThunderLevelPacket());
    }
}