Module moe.maple.script.api
Package moe.maple.api.script.model.object.user

Interface QuestHolderObject<T>

Type Parameters:
T - Typically a user/character.
All Superinterfaces:
ScriptObject<T>
public interface QuestHolderObject<T>
extends ScriptObject<T>
An object that has a collection of quests.

  • Method Summary

    Modifier and Type Method Description
    default boolean complete​(int questId)  
    default boolean containsEx​(int questId, String key, String value)  
    default String getEx​(int questId, String key)  
    Optional<QuestObject> getQuest​(int questId)  
    int getState​(int questId)
    This should return 0-2 depending on a quests current status 0 - NotStarted 1 - In Progress 2 - Complete
    default String getValue​(int questId)
    Elements in the quest record may have a String value.
    default boolean isComplete​(int questId)  
    default boolean isInProgress​(int questId)  
    boolean remove​(short key, boolean force)
    Forfeits the quest.
    default boolean setEx​(int questId, String key, String value)  
    default boolean setState​(int questId, int state)  
    default boolean setValue​(int questId, String value)
    Sets a quest record's String value.
    default boolean start​(int questId)  

    Methods inherited from interface moe.maple.api.script.model.object.ScriptObject

    get

  • Method Details

    • getState

      int getState​(int questId)
      This should return 0-2 depending on a quests current status 0 - NotStarted 1 - In Progress 2 - Complete
      Returns:
      int representing quest status

    • setState

      default boolean setState​(int questId, int state)
      Parameters:
      questId - the quest
      state - the state, see above
      Returns:
      true if the quest state was set

    • start

      default boolean start​(int questId)

    • complete

      default boolean complete​(int questId)

    • remove

      boolean remove​(short key, boolean force)
      Forfeits the quest.
      Parameters:
      key - a questId
      force - if TRUE, it will remove it from the quest record no matter what.
      Returns:
      true if successful.

    • isInProgress

      default boolean isInProgress​(int questId)

    • isComplete

      default boolean isComplete​(int questId)

    • getEx

      default String getEx​(int questId, String key)
      Returns:
      an empty string if the quest doesn't have the key

    • containsEx

      default boolean containsEx​(int questId, String key, String value)

    • getQuest

      Optional<QuestObject> getQuest​(int questId)

    • setEx

      default boolean setEx​(int questId, String key, String value)

    • getValue

      default String getValue​(int questId)
      Elements in the quest record may have a String value. Many quests rely on this value.
      Parameters:
      questId - A quest id key.
      Returns:
      A string quest progress value

    • setValue

      default boolean setValue​(int questId, String value)
      Sets a quest record's String value.
      Parameters:
      questId - A quest id key.
      value - A quest progress value.
      Returns:
      true if the value was set successfully