Difference between revisions of "Quest Documentation"

From Legends of Aria Admin and Modding Wiki
Jump to: navigation, search
(Quest Giver)
(Functions)
Line 4: Line 4:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! Function Name !! Description
+
! Function Name !! Arguments !! Description
 
|-
 
|-
| AddSlayTask|| Adds a slay task to the quest table
+
| AddSlayTask|| template,amount,objvarneeded,killname ||Adds a slay task to the quest table
 
|-
 
|-
| AddHarvestTask || Adds a harvest task to the quest table
+
| AddHarvestTask|| template,amount,objvarneeded,collectname || Adds a harvest task to the quest table
 
|-
 
|-
| AddCraftTask || Adds a craft quest to the quest table
+
| AddCraftTask|| template,amount,resourceneeded,collectname || Adds a craft quest to the quest table
 
|-
 
|-
| AddTameTask || Adds a tame quest to the quest table
+
| AddTameTask|| template,amount,objvarneeded,collectname || Adds a tame quest to the quest table
 
|-
 
|-
| CanGetQuest || Checks to see if the player can get the quest
+
| CanGetQuest|| player,questgiver,questname || Checks to see if the player can get the quest
 
|-
 
|-
| HasQuest || Checks to see if the player has the quest
+
| HasQuest|| player,questname || Checks to see if the player has the quest
 
|-
 
|-
| GiveQuest || Give the player a quest and toss it in the quest log
+
| GiveQuest|| player,questname || Give the player a quest and toss it in the quest log
 
|-
 
|-
| RemoveQuest || Remove a quest by name from the player
+
| RemoveQuest|| player,questname || Remove a quest by name from the player
 
|-
 
|-
| IsQuestComplete || Checks if the quest tasks are completed or not
+
| IsQuestComplete|| player,questname || Checks if the quest tasks are completed or not
 
|-
 
|-
| CheckQuestObjectives || Checks to see if the player completed a part of the objective
+
| CheckQuestObjectives|| player,object || Checks to see if the player completed a part of the objective
 
|-
 
|-
| CheckDelay|| Checks to see if the player an pick the quest up again (daily,hourly) or what other interval
+
| CheckDelay|| player,quest || Checks to see if the player an pick the quest up again (daily,hourly) or what other interval
 
|}
 
|}
 +
 
==Quest Giver==
 
==Quest Giver==
 
The quest system has a few limitations as of now but can be fixed either by me later when I get around to it, or feel free to do it yourself in your own methods<BR><BR>
 
The quest system has a few limitations as of now but can be fixed either by me later when I get around to it, or feel free to do it yourself in your own methods<BR><BR>

Revision as of 13:04, 20 June 2018

back to Project Phoenix#Quests

Functions

CustomQuests.Helpers.<FunctionName>(Args)

Function Name Arguments Description
AddSlayTask template,amount,objvarneeded,killname Adds a slay task to the quest table
AddHarvestTask template,amount,objvarneeded,collectname Adds a harvest task to the quest table
AddCraftTask template,amount,resourceneeded,collectname Adds a craft quest to the quest table
AddTameTask template,amount,objvarneeded,collectname Adds a tame quest to the quest table
CanGetQuest player,questgiver,questname Checks to see if the player can get the quest
HasQuest player,questname Checks to see if the player has the quest
GiveQuest player,questname Give the player a quest and toss it in the quest log
RemoveQuest player,questname Remove a quest by name from the player
IsQuestComplete player,questname Checks if the quest tasks are completed or not
CheckQuestObjectives player,object Checks to see if the player completed a part of the objective
CheckDelay player,quest Checks to see if the player an pick the quest up again (daily,hourly) or what other interval

Quest Giver

The quest system has a few limitations as of now but can be fixed either by me later when I get around to it, or feel free to do it yourself in your own methods

  1. You can only display 3 quest choices on any NPC due to user interface size.
  2. All quests can be repeated, you are given a Delay value.

Template

Object Variables

Initializer

Quest Table

Quest Objectives

Quest Rewards