Merge pull request #202 from kisuka/master

Quest Bubbles (Actually Works Finally)

1 files changed, 67 insertions, 18 deletions

diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 9969ff1a8..bd0b032f1 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -7886,10 +7886,56 @@ that fails, the command returns an empty string instead.
 =========================
 ---------------------------------------
 
+*questinfo <Quest ID>, <Icon> {, <Map Mark Color>{, <Job Class>}};
+
+This is esentially a combination of checkquest and showevent. Use this only
+in an OnInit label. For the Quest ID, specify the quest ID that you want
+checked if it has been started yet.
+
+For Icon, use one of the following:
+
+No Icon		: QTYPE_NONE
+! Quest Icon	: QTYPE_QUEST
+? Quest Icon	: QTYPE_QUEST2
+! Job Icon	: QTYPE_JOB
+? Job Icon	: QTYPE_JOB2
+! Event Icon	: QTYPE_EVENT
+? Event Icon	: QTYPE_EVENT2
+Warg		: QTYPE_WARG
+Warg Face	: QTYPE_WARG2 (Only for packetver >= 20120410)
+
+Map Mark Color, when used, creates a mark in the user's mini map on the position of the NPC,
+the available color values are:
+
+0 - No Marker
+1 - Yellow Marker
+2 - Green Marker
+3 - Purple Marker
+
+When a user shows up on a map, each NPC is checked for questinfo that has been set.
+If questinfo is present, it will check if the quest has been started, if it has not, the bubble will appear.
+
+Optionally, you can also specify a Job Class if the quest bubble should only appear for a certain class.
+
+Example
+izlude,100,100,4	script	Test	844,{
+	mes "[Test]";
+	mes "Hello World.";
+	close;
+
+	OnInit:
+		questinfo 1001, QTYPE_QUEST, 0, Job_Novice;
+		end;
+}
+
+---------------------------------------
+
 *setquest <ID>;
 
 Place quest of <ID> in the users quest log, the state of which is "active".
 
+If *questinfo is set, and the same ID is specified here, the icon will be cleared when the quest is set.
+
 ---------------------------------------
 
 *completequest <ID>;
@@ -7937,27 +7983,30 @@ If parameter "HUNTING" is supplied:
 
 ---------------------------------------
 
-*showevent <state>, <color>;
+*showevent <icon>{,<mark color>}
+
+Show an emotion on top of a NPC, and optionally,
+a colored mark in the mini-map like "viewpoint".
+This is used to indicate that a NPC has a quest or an event to 
+a certain player. 
 
-Show a colored mark in the mini-map like "viewpoint" and an emotion on top 
-of a NPC. This is used to indicate that a NPC has a quest or an event to 
-certain player/s. 
+Available Icons:
 
-state can be:
-	0 = disable ( Used to disable and remove the mark and the emotion from 
-		the NPC. )
-	1 = exclamation emotion ( Used to show an important quest event to 
-		certain player. )
-	2 = interrogation emotion ( Used to show an non-important quest event 
-		to certain player. )
-Other value may cause client crashes.
+Remove Icon	: QTYPE_NONE
+! Quest Icon	: QTYPE_QUEST
+? Quest Icon	: QTYPE_QUEST2
+! Job Icon	: QTYPE_JOB
+? Job Icon	: QTYPE_JOB2
+! Event Icon	: QTYPE_EVENT
+? Event Icon	: QTYPE_EVENT2
+Warg		: QTYPE_WARG
+Warg Face	: QTYPE_WARG2 (Only for packetver >= 20120410)
 
-color can be:
-	0 = yellow "Quest"
-	1 = orange "Job"
-	2 = green "Event"
-	3 = an MVP flag
-Other values show a transparent mark in the mini-map.
+Mark Color:
+0 - No Mark
+1 - Yellow Mark
+2 - Green Mark
+3 - Purple Mark
 
 ----------------------------------------