Package ml.pluto7073.chemicals.handlers

Class ChemicalHandler

java.lang.Object
ml.pluto7073.chemicals.handlers.ChemicalHandler
Direct Known Subclasses:
HalfLifeChemicalHandler, LinearChemicalHandler, StaticChemicalHandler
public abstract class ChemicalHandler extends Object
The base class representing a Chemical

Three pre-made handlers already exist:

HalfLifeChemicalHandler

The most realistic of the two. Exponentially ticks down the amount of the chemical in the player's body based on the half life in ticks specified

LinearChemicalHandler

The simplest handler. Removed a set amount of chemical from the player each tick, until the amount reaches zero

StaticChemicalHandler

For chemicals that stay persistent in the player until death or a maximum amount is reached, where the latter will perform an action on the player defined in StaticChemicalHandler.onMaxAmountReached(Player)

  • Field Details

    • EMPTY

      public static final ChemicalHandler EMPTY

    • accessor

      protected final net.minecraft.network.syncher.EntityDataAccessor<Float> accessor

    • ticksAccessor

      protected final net.minecraft.network.syncher.EntityDataAccessor<Integer> ticksAccessor

    • maxRecommendedAmount

      protected final float maxRecommendedAmount

  • Constructor Details

    • ChemicalHandler

      public ChemicalHandler(float maxRecommendedAmount)

  • Method Details

    • tickPlayer

      public final void tickPlayer(net.minecraft.world.entity.player.Player player)

    • doTick

      public abstract void doTick(net.minecraft.world.entity.player.Player player)
      Updates the current amount of the chemical in the specified player
      Parameters:
      player - The player to update

    • get

      public float get(net.minecraft.world.entity.player.Player player)
      Gets the current amount of the chemical in the player
      Parameters:
      player - The player to retrieve
      Returns:
      Amount of the chemical

    • getStrength

      public float getStrength(net.minecraft.world.entity.player.Player player)
      Returns:
      The relative strength of the chemical in the specified player between 0 and 1, using maxRecommendedAmount

    • add

      public float add(net.minecraft.world.entity.player.Player player, float amount)
      Deprecated.
      Use ChemicalConsumer.addChemical(ChemicalHandler, AbsorptionType, float) or ChemicalConsumer.addChemical(ConsumedInstance) to properly add chemicals to player
      Adds the chemical to a player
      Parameters:
      player - The player to add to
      amount - The amount of the chemical to add
      Returns:
      The new amount of the chemical in the player

    • set

      public void set(net.minecraft.world.entity.player.Player player, float amount)
      Sets amount of chemical in a player

    • getEffectsForAmount

      public abstract Collection<net.minecraft.world.effect.MobEffectInstance> getEffectsForAmount(float amount, net.minecraft.world.level.Level level)
      Get a list of effects associated with an amount of this chemical
      Parameters:
      amount - Amount of the chemical
      level - The current Level, for utility purposes
      Returns:
      A list of MobEffectInstances

    • defineDataForPlayer

      public void defineDataForPlayer(net.minecraft.network.syncher.SynchedEntityData data)

    • appendTooltip

      public void appendTooltip(List<net.minecraft.network.chat.Component> tooltip, float amount, net.minecraft.world.item.ItemStack stack)
      Appends a tooltip to an item containing this chemical
      Parameters:
      tooltip - The current list of tooltips
      amount - The amount in the stack
      stack - The current stack, for utility purposes

    • getId

      public net.minecraft.resources.ResourceLocation getId()

    • getLanguageKey

      public String getLanguageKey()

    • formatAmount

      public String formatAmount(float amount)
      Appends the units that this amount is tracked in to the amount, e.g. amount + "mg" or amount + "L"

    • getMaxRecommendedAmount

      public float getMaxRecommendedAmount()
      Returns:
      the maximum amount of this drug in units that the player should logically have in their system. This shouldn't scale with any settings/game rules and doesn't serve as a hard limit, just a way to assign a percentage to the amount a player has

    • createCustomChemicalCommandExtension

      @Nullable public @Nullable com.mojang.brigadier.builder.LiteralArgumentBuilder<net.minecraft.commands.CommandSourceStack> createCustomChemicalCommandExtension()
      Implement this method if you want custom syntax for this chemical's command using /chemicals
      Returns:
      A LiteralArgumentBuilder representing the entire subcommand for this chemical

      Note: It is recommended that this begin with literal("YOUR_CHEMICAL_ID")

    • saveExtraPlayerData

      public void saveExtraPlayerData(net.minecraft.world.entity.player.Player player, net.minecraft.nbt.CompoundTag tag)
      Store any extra data required for the Chemical Handler
      Parameters:
      player - The player to store data from
      tag - The CompoundTag to store the data in

    • loadExtraPlayerData

      public void loadExtraPlayerData(net.minecraft.world.entity.player.Player player, net.minecraft.nbt.CompoundTag tag)
      Load any extra data required for the Chemical Handler
      Parameters:
      player - The player to load to
      tag - The tag to load from

    • createInstance

      public ConsumedInstance createInstance(ConsumedInstance.AbsorptionType type, float amount)
      Creates a new ConsumedInstance using this chemical handler.
      Parameters:
      type - The desired speed of absorption
      amount - The total amount of the chemical to add
      Returns:
      The new consumed instance

    • createInstance

      public ConsumedInstance createInstance(ConsumedInstance.AbsorptionType type, net.minecraft.world.item.ItemStack stack, net.minecraft.world.level.Level level)
      Creates a new ConsumedInstance using this chemical handler and the specified item as an instance of ChemicalContaining.
      Parameters:
      type - The desired speed of absorption
      stack - The item stack to get information from
      level - The current level
      Returns:
      The new consumed instance

    • contrast

      public void contrast(org.joml.Vector4f rgba, net.minecraft.world.entity.player.Player player)

    • bloom

      public void bloom(org.joml.Vector4f rgba, net.minecraft.world.entity.player.Player player)

    • init

      public static void init()