How to Script a Mission - Revision history

Demolish: /* Finishing off the Mission */

2013-10-22T20:07:08Z

‎Finishing off the Mission

Demolish at 19:50, 22 October 2013

2013-10-22T19:50:34Z

Demolish: Finally finished!

2013-10-21T17:13:29Z

Finally finished!

Demolish: /* Final Stage and Missions.lua */

2013-10-21T17:11:57Z

‎Final Stage and Missions.lua

Demolish: /* Missions.lua */

2013-10-21T16:28:53Z

‎Missions.lua

Demolish at 16:03, 21 October 2013

2013-10-21T16:03:51Z

Demolish at 15:44, 21 October 2013

2013-10-21T15:44:48Z

Demolish: /* Finishing off the Mission */

2013-10-21T15:35:50Z

‎Finishing off the Mission

Demolish at 15:09, 21 October 2013

2013-10-21T15:09:37Z

Demolish at 17:50, 20 October 2013

2013-10-20T17:50:43Z

@@ Line 527: / Line 527: @@
 Okay done that, now what?
 <pre>
-After the cutscene, you can exit through the Marble Door on the South end of the room. This will take you back to Heavens Tower in Windurst.
+After the cutscene, you can exit through the Marble Door on the South end of the room.
 </pre>
 Transporter added, player can exit through that as well as the Marble Door they entered through; next!

@@ Line 471: / Line 471: @@
 Upon 'talking' to the Tome(s) of Magic, we discover it doesn't have a script so go ahead and [[#Tome_of_Magic_Template|[copy the template]]] and save the file as <code>Tome_of_Magic.lua</code>.
-''Note: All the Tomes of Magic have got the same name in npc_list.sql... Usually they'd have a different name but for the sake of keeping things simple, go into npc_list and rename <code>npcid:'385','Tome_of_Magic'</code> to <code>'385,'Real_Tome_of_Magic'</code>. Now re-import the npc_list sql file, restart DSGameServer, go to the NPCs pos (in-game) and click on it. If changed correctly an error should be reported in DSGameServer.exe for the Tome on the far left of the room on the floor when entering through the Marble Door (by the table).
+''Note: All the Tomes of Magic have got the same name in npc_list.sql... For this to work correctly you need to find the correct NPCs ID. You then add the following code and talk to that NPC.
-Ok now lets open up the script for <code>Tome_of_Magic</code> (the Tomes that throw random info, '''not''' the 'Real Tome') and add the checks for the mission and what stage the player is at like so:
+Ok now lets open up the script for <code>Tome_of_Magic</code>, add the checks for the mission, check which Tome it is and what stage the player is at like so:
 <pre>
 function onTrigger(player,npc)
 local CurrentMission = player:getCurrentMission(WINDURST);
 local WindyKills = player:getVar("Windurst_7-1Kills");
-	if(CurrentMission == THE_SIXTH_MINISTRY and WindyKills == 4) then
+print("This Tome's ID is "..npcId);
 		local cutscene = math.random(0x041,0x044); -- Selects a cutscene (from 0x041 to 0x044)
@@ Line 489: / Line 493: @@
 end;
 </pre>
-Now remember, these are the other Tomes that just give information but aren't needed for the mission.
+Now lets talk to the correct Tome (on the floor to the left of the Marble Door you entered through) and find it's ID.
-Since all the un-needed 'fake' Tomes have the same names (in-game and in npc_list) I decided to be lazy and have them play either cutscene <code>0x041, 0x042, 0x043</code> or <code>0x044</code>(these cutscenes are general info cutscenes). This was so I didn't need to add extra scripts by renaming the NPCs. (I don't recommend doing this in any other case but it doesn't matter for these).
+Check DSGameServer and see what this NPCs ID is.
-Alright now lets make a ''copy'' of <code>Tome_of_Magic.lua</code> and rename it to "<code>Real_Tome_of_Magic.lua</code>".
+Once you got the correct ID; add the following code to check if we're talking to the correct Tome:
-Open up the script and modify the @pos to match that of the correct/real Tome and set it to play the correct cutscene (0x0045) and set the variable upon finishing the cutscene like so:
 <pre>
 function onTrigger(player,npc)
 local CurrentMission = player:getCurrentMission(WINDURST);
 local WindyKills = player:getVar("Windurst_7-1Kills");
-	if(CurrentMission == THE_SIXTH_MINISTRY and WindyKills == 4) then
+	if(npcId == 17469825) then -- If it's this NPC then check the players mission and
-		player:startEvent(0x0045);
+		if(CurrentMission == THE_SIXTH_MINISTRY and WindyKills == 4 and MissionStatus == 1) then
-	end
+			player:startEvent(0x0045);
+		end
-end;
--- ..... cut out lines not needed
+	else
--- ...
+		local cs = math.random(0x041,0x044);
-function onEventFinish(player,csid,option)
+		player:startEvent(cs);
---printf("CSID: %u",csid);
---printf("RESULT: %u",option);
-−
-	if (csid == 0x0045) then
-		player:setVar("MissionStatus",2);
 	end
 end;
 </pre>
 The player now has two options to get out of this room; use the Transporter or exit through the door they entered.

@@ Line 1: / Line 1: @@
 In this page you will learn how to script a mission from scratch as well as some other useful information.
@@ Line 673: / Line 672: @@
 Next we tell the 'function list' (pair of {}'s after npc's csid) what to do;
 ''IMPORTANT:[[#Function_List|[Here's the full list of functions for 'function list']]]'' e.g. how you'd setRank or addGil etc.

@@ Line 591: / Line 591: @@
 	elseif(csid == 0x02d4) then
-		finishMissionTimeline(player,3,csid,option); -- See.. Not as simple as you first thought!
+		finishMissionTimeline(player,4,csid,option); -- See.. Not as simple as you first thought!
 	end
@@ Line 640: / Line 641: @@
 --        ^^         ^^^^        ^^^^            ^         ^
 --missionid^|guard1csid^| guard2csid^| guard3csid^|NPC1csid^ | ^        function list                ^|
 </pre>

← Older revision		Revision as of 16:28, 21 October 2013
Line 601:		Line 601:

	=== Missions.lua ===		=== Missions.lua ===
		+
		+	Navigate to <code>scripts/globals/</code> and open <code>missions.lua</code>.
		+	Scroll down to around ''Line 790'' or ''Ctrl+F'' for <code>finishMissionTimeline</code>.
		+	You'll see something like this:
		+	<pre>
		+	function finishMissionTimeline(player,guard,csid,option)
		+
		+	nation = player:getNation();
		+
		+	-- To prevent the cs conflict, use the 1st and 2nd for guard and 3/4 for npc
		+	-- missionid, {Guard1CS,option}, {Guard2CS,option}, {NPC1 CS,option}, {NPC2 CS,option}, {{function,value},...},
		+	-- 1: player:addMission(nation,mission);
		+	</pre>
		+	For now lets ignore this part and skip to Line 888-ish (<code>elseif(nation == WINDURST)</code>)
		+
		+	You'll see something like this:
		+	<pre>
		+	timeline = {
		+
		+	-- NOTE: CUT OUT THE LINES NOT RELEVANT TO OUR MISSION
		+
		+
		+	15,{0x00D8,0},{0,0}, {0,0}, {0,0}, {{11,6},{14,0},{9,74},{8,20000},{6},{12}}, -- MISSION 5-2 (Finish (Star Sibyl))
		+
		+
		+	16,{0,0}, {0,0}, {0x0032,0},{0,0}, {{14,0},{5,650},{0,0},{0,0},{0,0},{12}}, -- MISSION 6-1 (Finish (Zone: Full Moon Fountain))
		+
		+
		+	17,{0,0}, {0,0}, {0x0138,0},{0,0}, {{14,0},{11,7},{8,40000},{6},{0,0},{12}} -- MISSION 6-2 (Finish (Star Sibyl))
		+
		+	}
		+	</pre>
		+	Now you may be thinking: "This is confusing as fuck." but don't worry, it's not.
		+
		+	Here's what it means:
		+	<pre>
		+	17, {0,0}, {0,0}, {0x0138,0}, {0,0}, {{14,0},{11,7},{8,40000},{6},{0,0},{12}}
		+	-- ^^ ^^^^ ^^^^ ^ ^
		+	--missionid^\|guard1csid^\| guard2csid^\| guard3csid^\|NPC1csid^ \| ^ function list ^\|
		+	</pre>

	= Other info and Templates =		= Other info and Templates =

@@ Line 527: / Line 527: @@
 The player now has two options to get out of this room; use the Transporter or exit through the door they entered.
-Since i'm feeling generous you can have the [[#Transporter_Script|[Transporter script]]].
+Since i'm feeling generous, you can have the [[#Transporter_Script|[Transporter script]]].
 <pre>
 After the cutscene, you can exit through the Marble Door on the South end of the room. This will take you back to Heavens Tower in Windurst.
 Head back to the Optistery and speak with Tosuka-Porika to finish the mission and to receive the key item Blank Book of the Gods.
 </pre>
 = Other info and Templates =

@@ Line 525: / Line 525: @@
 end;
 </pre>
-Notice how we used <code>player:setVar("Windurst_7-1Kills",0)</code>. By setting the variable to 0, we delete that variable so it doesn't clog up the database once we're done with it.
+The player now has two options to get out of this room; use the Transporter or exit through the door they entered.
 <pre>
@@ Line 634: / Line 636: @@
 [[#Tracking_progress_through_variables|[Click here to return to the step you were on]]]
 == Tome of Magic Template ==
@@ Line 709: / Line 692: @@
 </pre>
 [[#Finishing_off_the_Mission|[Click here to return to the step you were on]]]
 == Mob IDs ==

@@ Line 470: / Line 470: @@
 We're almost done!
 Now we just need to talk to the Tome of Magic and finish off the Mission when returning to Tosuka-Porika.
-(Guide almost finished)
+Upon 'talking' to the Tome(s) of Magic, we discover it doesn't have a script so go ahead and [[#Tome_of_Magic_Template|[copy the template]]] and save the file as <code>Tome_of_Magic.lua</code>.
 = Other info and Templates =
-=== Marble Door Template ===
+== Marble Door Template ==
 For a little more information, read the block of text just under this template while you're here or [[#Adding_special_checks|[Click here to return to the step you were on]]].
 <pre>
@@ Line 539: / Line 540: @@
 [[#Adding_special_checks|[Click here to return to the step you were on]]]
-=== Hinge Oil Template ===
+== Hinge Oil Template ==
 [[#Tracking_progress_through_variables|[Click here to return to the step you were on]]]
 <pre>
@@ Line 594: / Line 595: @@
 </code>
 [[#GetNPCByID|[Click here to return to the step you were on]]]
 == Mob IDs ==

@@ Line 465: / Line 465: @@
 This checks if the player's Current Mission is THE SIXTH MINISTRY and they've got the kills required AND the following mobs are de-spawned/dead then open the door.
 = Other info and Templates =
@@ Line 578: / Line 585: @@
 Unfortunately it isn't as simple as that.
 <code>GetNPCByID</code> requires the long NPC ID (17469795).
 To get the long (or 'old style') NPC ID you can either use '''[https://forums.dspt.info/viewtopic.php?f=16&p=8103 this tool]''' or convert it to the old style like so: