Record Class QuestType

java.lang.Object
java.lang.Record
com.botwithus.bot.api.model.QuestType
Record Components:
id - the quest type ID
name - the quest name
listName - the display name in the quest list, or empty
category - the quest category
difficulty - the quest difficulty rating
membersOnly - whether this quest requires membership
questPoints - the quest points rewarded on completion
questPointReq - the quest points required to start
questItemSprite - the quest journal item sprite ID, or -1 for none
startLocations - the tile coordinates of quest start locations
alternateStartLocation - the alternate start location identifier
dependentQuestIds - IDs of quests that must be completed first
skillRequirements - the skill requirements to start the quest
progressVarps - the varps used to track quest progress
progressVarbits - the varbits used to track quest progress
params - additional key-value parameters from the quest definition
public record QuestType(int id, String name, String listName, int category, int difficulty, boolean membersOnly, int questPoints, int questPointReq, int questItemSprite, List<Integer> startLocations, int alternateStartLocation, List<Integer> dependentQuestIds, List<Map<String,Object>> skillRequirements, List<Map<String,Object>> progressVarps, List<Map<String,Object>> progressVarbits, Map<String,Object> params) extends Record
Quest definition from the game cache.
See Also:

  • Constructor Details

    • QuestType

      public QuestType(int id, String name, String listName, int category, int difficulty, boolean membersOnly, int questPoints, int questPointReq, int questItemSprite, List<Integer> startLocations, int alternateStartLocation, List<Integer> dependentQuestIds, List<Map<String,Object>> skillRequirements, List<Map<String,Object>> progressVarps, List<Map<String,Object>> progressVarbits, Map<String,Object> params)
      Creates an instance of a QuestType record class.
      Parameters:
      id - the value for the id record component
      name - the value for the name record component
      listName - the value for the listName record component
      category - the value for the category record component
      difficulty - the value for the difficulty record component
      membersOnly - the value for the membersOnly record component
      questPoints - the value for the questPoints record component
      questPointReq - the value for the questPointReq record component
      questItemSprite - the value for the questItemSprite record component
      startLocations - the value for the startLocations record component
      alternateStartLocation - the value for the alternateStartLocation record component
      dependentQuestIds - the value for the dependentQuestIds record component
      skillRequirements - the value for the skillRequirements record component
      progressVarps - the value for the progressVarps record component
      progressVarbits - the value for the progressVarbits record component
      params - the value for the params record component

  • Method Details

    • 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.

    • id

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

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • listName

      public String listName()
      Returns the value of the listName record component.
      Returns:
      the value of the listName record component

    • category

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

    • difficulty

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

    • membersOnly

      public boolean membersOnly()
      Returns the value of the membersOnly record component.
      Returns:
      the value of the membersOnly record component

    • questPoints

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

    • questPointReq

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

    • questItemSprite

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

    • startLocations

      public List<Integer> startLocations()
      Returns the value of the startLocations record component.
      Returns:
      the value of the startLocations record component

    • alternateStartLocation

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

    • dependentQuestIds

      public List<Integer> dependentQuestIds()
      Returns the value of the dependentQuestIds record component.
      Returns:
      the value of the dependentQuestIds record component

    • skillRequirements

      public List<Map<String,Object>> skillRequirements()
      Returns the value of the skillRequirements record component.
      Returns:
      the value of the skillRequirements record component

    • progressVarps

      public List<Map<String,Object>> progressVarps()
      Returns the value of the progressVarps record component.
      Returns:
      the value of the progressVarps record component

    • progressVarbits

      public List<Map<String,Object>> progressVarbits()
      Returns the value of the progressVarbits record component.
      Returns:
      the value of the progressVarbits record component

    • params

      public Map<String,Object> params()
      Returns the value of the params record component.
      Returns:
      the value of the params record component