Record Class QuestRewards

java.lang.Object
java.lang.Record
net.ixdarklord.folios.internal.quest.QuestRewards
public record QuestRewards(List<net.minecraft.world.item.ItemStack> items, List<QuestRewards.Choice> random, int rolls) extends Record
A quest's "rewards": items it always gives, and random gifts, each drawn from a list: 
"rewards": {
  "items": ["minecraft:diamond*3", {"id": "minecraft:potion", "components": {...}}],
  "random": [{"item": "minecraft:emerald*4", "weight": 3}, "minecraft:gold_ingot*8"],
  "random_rolls": 1
}
Read the same way on the server, which gives them, and on the client, which shows them.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final record 
    QuestRewards.Choice
    A random gift's choice, picked weight times as often as one of weight 1.

  • Constructor Summary

    Constructors
    Constructor
    Description
    QuestRewards(List<net.minecraft.world.item.ItemStack> items, List<QuestRewards.Choice> random, int rolls)
    Creates an instance of a QuestRewards record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    void
    give(net.minecraft.server.level.ServerPlayer player)
    Gives them to a player: into their inventory, or at their feet where it is full; the random gifts drawn now.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isEmpty()
     
    List<net.minecraft.world.item.ItemStack>
    items()
    Returns the value of the items record component.
    List<QuestRewards.Choice>
    random()
    Returns the value of the random record component.
    static QuestRewards
    read(com.google.gson.JsonObject json, net.minecraft.core.HolderLookup.Provider registries)
    Rewards as written, their items made with the registries given (the server's, or the client's world's).
    int
    rolls()
    Returns the value of the rolls record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • QuestRewards

      public QuestRewards(List<net.minecraft.world.item.ItemStack> items, List<QuestRewards.Choice> random, int rolls)
      Creates an instance of a QuestRewards record class.
      Parameters:
      items - the value for the items record component
      random - the value for the random record component
      rolls - the value for the rolls record component

  • Method Details

    • isEmpty

      public boolean isEmpty()

    • read

      public static QuestRewards read(com.google.gson.JsonObject json, net.minecraft.core.HolderLookup.Provider registries)
      Rewards as written, their items made with the registries given (the server's, or the client's world's).

    • give

      public void give(net.minecraft.server.level.ServerPlayer player)
      Gives them to a player: into their inventory, or at their feet where it is full; the random gifts drawn now.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • items

      public List<net.minecraft.world.item.ItemStack> items()
      Returns the value of the items record component.
      Returns:
      the value of the items record component

    • random

      public List<QuestRewards.Choice> random()
      Returns the value of the random record component.
      Returns:
      the value of the random record component

    • rolls

      public int rolls()
      Returns the value of the rolls record component.
      Returns:
      the value of the rolls record component