Difference between revisions of "LUA:Quests"

 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
details to come
+
{{PageHeaderChild|LUA|Quest Scripts}}
 +
 
 +
Quest scripts are what makes quests work, there are only 4 core functions however custom functions are needed for a quest to work properly.  These custom functions can be declared with [[LUA:AddQuestStepCompleteAction|AddQuestStepCompleteAction()]] and [[LUA:SetQuestCompleteAction|SetQuestCompleteAction()]], in both cases the first parameter is the quest the second is the player.
 +
 
 +
{{Header|Accepted|BackgroundColor=3d78b4|FontColor=ffffff}}
 +
Accepted is called when the player accepts the quest
 +
 
 +
<pre>
 +
function Accepted(Quest, Spawn)
 +
end
 +
</pre>
 +
{{Header|Declined|BackgroundColor=3d78b4|FontColor=ffffff}}
 +
Declined is called when the player declines the quest
 +
 
 +
<pre>
 +
function Declined(Quest, Spawn)
 +
end
 +
</pre>
 +
{{Header|Deleted|BackgroundColor=3d78b4|FontColor=ffffff}}
 +
Deleted is called when a player deletes a quest
 +
 
 +
<pre>
 +
function Deleted(Quest, Spawn)
 +
end
 +
</pre>
 +
{{Header|Init|BackgroundColor=3d78b4|FontColor=ffffff}}
 +
Init sets up the quest, this must be included in all quest scripts
 +
 
 +
<pre>
 +
function Init(Quest)
 +
end
 +
</pre>
 +
{{Header|Reload|BackgroundColor=3d78b4|FontColor=ffffff}}
 +
Reload is called when a player logs in with an incomplete quest, the third parameter is the step id the player is on
 +
 
 +
<pre>
 +
function Reload(Quest, Spawn, int32)
 +
end
 +
</pre>

Latest revision as of 16:30, 14 June 2016

LUA - Quest Scripts

Return to: LUA | Tutorials | Portal | Forum | Project Manager | Bug Tracker


Quest scripts are what makes quests work, there are only 4 core functions however custom functions are needed for a quest to work properly. These custom functions can be declared with AddQuestStepCompleteAction() and SetQuestCompleteAction(), in both cases the first parameter is the quest the second is the player.

Accepted

Accepted is called when the player accepts the quest

function Accepted(Quest, Spawn)
end
Declined

Declined is called when the player declines the quest

function Declined(Quest, Spawn)
end
Deleted

Deleted is called when a player deletes a quest

function Deleted(Quest, Spawn)
end
Init

Init sets up the quest, this must be included in all quest scripts

function Init(Quest)
end
Reload

Reload is called when a player logs in with an incomplete quest, the third parameter is the step id the player is on

function Reload(Quest, Spawn, int32)
end