---

Contents

---

Introduction

Object instance: quests

---

Description

Adds helper functions for creating & manipulating quests & exposes select public methods of the StendhalQuestSystem class.

Methods

---

quests:cache

• Call register directly from the quest instance.
• Caches a quest for loading at server startup.
• Parameters:
  • quest IQuest Quest instance to be cached.

---

quests:create

• Creates a new quest.
• Parameters:
  • slotName string Quest slot identifier.
  • name string The reader friendly name that can be shown in travel log.
  • desc string Quest description.
• Returns: LuaQuest New quest instance.

---

quests:createBuilder

• Creates a quest builder to pass to quests:createManuscript.
• Parameters:
  • task string Quest task type. Supported are "BringItemTask" & "KillCreaturesTask".
• Returns: QuestBuilder New quest builder instance.

---

quests:createManuscript

• Creates a new quest in manuscript format.
• Parameters:
  • builder QuestBuilder A quest builder instance that defines quest.
• Returns: QuestManuscript New quest instance.

---

quests:getCompleted

• Retrieves a list of completed quests from a player.
• Parameters:
  • player Player Player instance to be checked.
• Returns: List<String> List of string identifiers for completed quests.
• TODO:
  • Return table instead of Java list.

---

quests:getDescription

• Retrieves the description of a quest.
• Parameters:
  • player Player Player instance to be checked.
  • questName string Name of the quest.
• Returns: string Description.

---

quests:getDescriptionForUnstartedInRegionFromNPCName

• Retrieves quest descriptions for unstarted quests in a specified region matching a specific NPC name.
• Parameters:
  • player Player Player instance to be checked.
  • region string Region to check in.
  • name string Name of NPC.
• Returns: java.util.List<java.lang.String>
• TODO:
  • Return table instead of Java list.

---

quests:getIncomplete

• Retrieves a list of incomplete quests in a specified region.
• Parameters:
  • player Player Player instance to be checked.
  • region string Region name/identifier.
• Returns: java.util.List<java.lang.String> List of string identifiers of incomplete quests in region.
• TODO:
  • Return table instead of Java list.

---

quests:getLevelWarning

• If the quest is too dangerous, add a warning unless the player has already completed it.
• Parameters:
  • player Player Player instance to be checked.
  • questName string Name of the quest.
• Returns: string

---

quests:getNPCNamesForUnstartedInRegionForLevel

• Retrieves a list of the unique npc names for unstarted quests in a specified region.
• Parameters:
  • player Player Player instance to be checked.
  • region string Region to check in.
• Returns: java.util.List<java.lang.String>
• TODO:
  • Return table instead of Java list.

---

quests:getOpen

• Retrieves a list of open quests from a player.
• Parameters:
  • player Player Player instance to be checked.
• Returns: java.util.List<java.lang.String> List of string identifiers for open quests.
• TODO:
  • Return table instead of Java list.

---

quests:getProgressDetails

• Retrieves details on the progress of the quest.
• Parameters:
  • player Player Player instance to be checked.
  • questName string Name of the quest.
• Returns: java.util.List>java.lang.String<
• TODO:
  • Return table instead of Java list.

---

quests:getQuest

• Retrieves the IQuest object for a named quest.
• Parameters:
  • questName string Name of quest.
• Returns: IQuest Quest instance or nil if doesn't exist.

---

quests:getQuestFromSlot

• Retrieves the IQuest object for a quest.
• Parameters:
  • questSlot string Quest identifier string.
• Returns: IQuest Quest instance or nil if doesn't exist.

---

quests:getRepeatable

• Retrieves a list of quests a player has completed, and can now do again.
• Parameters:
  • player Player Player instance to be checked.
• Returns: java.util.List>java.lang.String<
• TODO:
  • Return table instead of Java list.

---

quests:isLoaded

• Checks if a quest has been loaded.
• Parameters:
  • quest IQuest Quest instance to check.
• Returns: bool true if the instance matches stored quests.

---

quests:list

• Creates a report on a specified quest for a player.
• Parameters:
  • player Player Player to create the report for.
  • questName string Name of quest to be reported.
• Returns: string Report.

---

quests:listAll

• List all quests the player knows about.
• Parameters:
  • player Player Player to create the report for.
• Returns: string Report.

---

quests:listStates

• Dumps the internal quest states for the specified player. This is used for the InspectAction.
• Parameters:
  • player Player Player to create the report for.
• Returns: string Report.

---

quests:load

• Adds a quest to the world.
• Parameters:
  • quest IQuest The quest instance to be loaded.

---

quests:register

• DEPRECATED: Call register directly from the quest instance.
• Caches a quest for loading at startup. Alias for quests:cache.
• Parameters:
  • quest IQuest Quest instance to be cached.

---

quests:unload

• Removes a quest from the world.
• Parameters:
  • questName string Name of the quest to be removed.

---

Classes

---

LuaQuest

See: LuaQuest

---

Public Members

---

LuaQuest.completedCheck

• Called by LuaQuest.isCompleted.
• Type: function

---

LuaQuest.formattedHistory

• Called by LuaQuest.getFormattedHistory.
• Type: function

---

LuaQuest.history

• Called by LuaQuest.getHistory.
• Type: function

---

LuaQuest.init

• Called by IQuest.addToWorld.
• Type: function

---

LuaQuest.remove

• Called by IQuest.removeFromWorld.
• Type: function

---

LuaQuest.repeatableCheck

• Called by LuaQuest.isRepeatable.
• Type: function

---

LuaQuest.startedCheck

• Called by LuaQuest.isStarted.
• Type: function

---

Public Methods

---

LuaQuest:addToWorld

• See IQuest.addToWorld.

---

LuaQuest:getFormattedHistory

• See IQuest.getFormattedHistory.

---

LuaQuest:getHistory

• See IQuest.getHistory

---

LuaQuest:getMinLevel

• See IQuest.getMinLevel

---

LuaQuest:getNPCName

• See IQuest.getNPCName

---

LuaQuest:getName

• See IQuest.getName

---

LuaQuest:getOriginalName

• Retrieves unformatted quest name.
• Returns: string Unmodified quest name string.

---

LuaQuest:getRegion

• See IQuest.getRegion

---

LuaQuest:getSlotName

• See IQuest.getSlotName

---

LuaQuest:isCompleted

• See IQuest.isCompleted

---

LuaQuest:isRepeatable

• See IQuest.isRepeatable

---

LuaQuest:isStarted

• See IQuest.isStarted

---

LuaQuest:isVisibleOnQuestStatus

• See IQuest.isVisibleOnQuestStatus

---

LuaQuest:register

• Registers quest to be added to world at server startup. If called without parameters LuaQuest.init must be set first.
• Parameters:
  • func function Function to execute when quests:loadQuest is called.

---

LuaQuest:removeFromWorld

• See IQuest.removeFromWorld

---

LuaQuest:setAddFunction

• DEPRECATED: Set LuaQuest.init directly.
• Sets the function for adding the quest to the game.
• Parameters:
  • func function Function to invoke when LuaQuest.addToWorld is called.

---

LuaQuest:setCompletedCheckFunction

• Sets the function for checking if the quest is started.
• Parameters:
  • func function Function to invoke when LuaQuest.isCompleted is called.

---

LuaQuest:setDescription

• Sets the quest description string.
• Parameters:
  • desc string Quest description string.

---

LuaQuest:setFormattedHistoryFunction

• Sets the function for retrieving formatted history of quest state.
• Parameters:
  • func function Function to invoke when LuaQuest.getFormattedHistory is called.

---

LuaQuest:setHistoryFunction

• Sets the function for retrieving history of quest state.
• Parameters:
  • func function Function to invoke when LuaQuest.getHistory is called.

---

LuaQuest:setMinLevel

• Sets the recommended minimum level.
• Parameters:
  • level int Level to return when LuaQuest.getMinLevel is called.

---

LuaQuest:setNPCName

• Sets the NPC name.
• Parameters:
  • name string NPC name to return when LuaQuest.getNPCName is called.

---

LuaQuest:setName

• Sets the quest name string.
• Parameters:
  • name string Quest name string to be returned when LuaQuest.getName is called.

---

LuaQuest:setRegion

• Sets the quest region.
• Parameters:
  • region string Region string to be returned when LuaQuest.getRegion is called.

---

LuaQuest:setRemoveFunction

• DEPRECATED: Set LuaQuest.remove directly.
• Sets the function for removing the quest from the game.
• Parameters:
  • func function Function to invoke when LuaQuest.removeFromWorld is called.

---

LuaQuest:setRepeatable

• Sets the repeatable status of the quest (overrides LuaQuest.setCompletedCheckFunction).
• Parameters:
  • repeatable bool If true, the quest is repeatable.

---

LuaQuest:setRepeatableCheckFunction

• Sets the function for checking if the quest is repeatable.
• Parameters:
  • func function Function to invoke when LuaQuest.isRepeatable is called.

---

LuaQuest:setSlotName

• Sets the quest identifier string.
• Parameters:
  • slot string Slot identifier string to be returned when LuaQuest.getSlotName is called.

---

LuaQuest:setStartedCheckFunction

• Sets the function for checking if the quest is started.
• Parameters:
  • func function Function to invoke when LuaQuest.isStarted is called.

---

LuaQuest:setVisibleOnQuestStatus

• Sets whether or not the quest should be shown in the travel log.
• Parameters:
  • visible bool If true, quest will be displayed in travel log.

---

Usage Examples

Standard quest example:

local loadStep1 = function()
    ...
end

local loadStep2 = function()
    ...
end

local myQuest = quests:create("my_quest", "My Quest")
myQuest:register(function()
    loadStep1()
    loadStep2()
end)

Example of CoalForHaunchy quest manuscript converted to Lua:

local itemBuilder = quests:createBuilder("BringItemTask")

itemBuilder:info()
    :name("Coal for Haunchy")
    :description("Haunchy Meatoch is afraid of his BBQ grillfire. Will his coal last till the steaks are ready or will he need some more?")
    :internalName("coal_for_haunchy")
    :repeatableAfterMinutes(2 * 24 * 60)
    :minLevel(0)
    :region(Region.ADOS_CITY)
    :questGiverNpc("Haunchy Meatoch")

itemBuilder:history()
    :whenNpcWasMet("Haunchy Meatoch welcomed me to the Ados market.")
    :whenQuestWasRejected("He asked me to fetch him some pieces of coal but I don't have time to collect some.")
    :whenQuestWasAccepted("The BBQ grill-heat is low and I promised Haunchy to help him out with 25 pieces of coal.")
    :whenTaskWasCompleted("I found 25 pieces of coal for the Haunchy and think he will be happy.")
    :whenQuestWasCompleted("Haunchy Meatoch was really happy when I gave him the coal, he has enough for now. He gave me some of the best steaks which I ever ate!")
    :whenQuestCanBeRepeated("But I'd bet his amount is low again and needs more. Maybe I'll get more grilled tasty steaks.")

itemBuilder:offer()
    :respondToRequest("I cannot use wood for this huge BBQ. To keep the heat I need some really old stone coal but there isn't much left. The problem is, that I can't fetch it myself because my steaks would burn then so I have to stay here. Can you bring me 25 pieces of #coal for my BBQ please?")
    :respondToUnrepeatableRequest("The coal amount behind my counter is still high enough. I will not need more for some time.")
    :respondToRepeatedRequest("The last coal you brought me is mostly gone again. Will you bring me some more?")
    :respondToAccept("Thank you! I'll be sure to give you a nice and tasty reward.")
    :respondTo({"coal"}):saying("Coal isn't easy to find. You normally can find it somewhere in the ground but perhaps you are lucky and find some in the old Semos Mine tunnels... Will you help me?")
    :respondToReject("Oh, never mind. I thought you love BBQs like I do. Bye then.")
    :rejectionKarmaPenalty(10.0)
    :remind("Luckily my BBQ is still going. But please hurry up to bring me 25 coal as you promised.")

entities:getNPC("Haunchy Meatoch"):addReply("coal", "Sometime you could do me a #favor ...")

itemBuilder:task()
    :requestItem(25, "coal")

itemBuilder:complete()
    :greet("Ah, I see, you have enough coal to keep my BBQ on! Is it for me?")
    :respondToReject("Well then, hopefully someone else will help me before my BBQ goes out.")
    :respondToAccept(nil)
    :rewardWith(actions:create("IncreaseXPAction", {200}))
    :rewardWith(actions:create("IncreaseKarmaAction", {20}))
    :rewardWith(actions:create("EquipRandomAmountOfItemAction", {"grilled steak", 1, 4, 1,
        "Thank you! Take [this_these] [number_item] from my grill!"}))

quests:register(quests:createManuscript(itemBuilder))