Package com.ordwen.odailyquests.api.quests

Interface IQuest

All Known Implementing Classes:
AbstractQuest, BasicQuest, BreakQuest, BreedQuest, CarveQuest, ConsumeQuest, CookQuest, CraftQuest, CrateOpenQuest, CustomMobQuest, CustomQuest, EliteMobsQuest, EnchantQuest, EntityQuest, ExpLevelQuest, ExpPointsQuest, FarmingQuest, FireballReflectQuest, FishQuest, GetQuest, ItemQuest, KillQuest, LaunchQuest, LocationQuest, MilkingQuest, MythicMobsQuest, NuVotifierQuest, PickupQuest, PlaceholderQuest, PlaceQuest, PlayerDeathQuest, ShearQuest, TameQuest, VillagerQuest, VotifierPlusQuest
public interface IQuest
Represents the base interface for all quest types in the quest system.

This interface defines the necessary methods that must be implemented by any class that represents a quest. These methods include retrieving the quest type, determining whether the quest can progress, and loading quest parameters.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canProgress(org.bukkit.event.Event provided, Progression progression)
    Determines if the quest can progress based on the provided event and progression information.
    String
    getType()
    Returns the type of the quest.
    boolean
    loadParameters(org.bukkit.configuration.ConfigurationSection section, String file, String index)
    Loads the parameters required for the quest from the provided configuration section.

  • Method Details

    • getType

      String getType()
      Returns the type of the quest.
      Returns:
      a string representing the type of the quest.

    • canProgress

      boolean canProgress(@Nullable org.bukkit.event.Event provided, Progression progression)
      Determines if the quest can progress based on the provided event and progression information.

      This method allows quests to check if they can proceed, often based on player actions or other conditions.

      Parameters:
      provided - the event that might trigger the progression (can be null if not applicable).
      progression - the progression information for the player.
      Returns:
      true if the quest can progress, false otherwise.

    • loadParameters

      boolean loadParameters(org.bukkit.configuration.ConfigurationSection section, String file, String index)
      Loads the parameters required for the quest from the provided configuration section.

      This method is used to load specific data about the quest from a configuration file. This could include quest objectives, items, or other quest-related data.

      Parameters:
      section - the configuration section containing the quest data.
      file - the file path from which the parameters are loaded.
      index - the index of the quest in the configuration.
      Returns:
      true if the parameters were successfully loaded, false otherwise.