Interface IQuestObjective


  • public interface IQuestObjective
    • Method Detail

      • getProgress

        int getProgress()
        If this function is used on a player within a party and the quest objective type is set to ALL. The return progress will be set to 0 for handling multiple players.
        Returns:
        progress of objective
      • setProgress

        void setProgress​(int progress)
        If this function is used on a player within a party and the quest objective type is set to ALL. It will set everyone to have the same progress within the party.
        Parameters:
        progress - Progress Amount
      • setPlayerProgress

        void setPlayerProgress​(String playerName,
                               int progress)
        This function is typically used for setting individual progress for a player in a party for a Quest Objective that is set for ALL Players. This function will work like the normal setProgress if the player does not have a party
        Parameters:
        playerName - Name of Player
        progress - Progress Amount
      • getMaxProgress

        int getMaxProgress()
        Returns:
        the target progress value needed to complete this objective.
      • isCompleted

        boolean isCompleted()
        Returns:
        true if this objective has been completed.
      • getText

        String getText()
        Returns:
        the objective description text.
      • getAdditionalText

        String getAdditionalText()
        Returns:
        additional display text for this objective, or null.