Hercules Wiki - User contributions [en]

Quest Log System

2013-07-03T06:05:55Z

Thanna: /* Increasing Max Quest DB */

== Quest Log System ==

==== Basic Structure of NPC ====

First of all you must have a knowledge on basic scripting, if not please kindly Click [[Basic_Scripting|Here!]].

==== Quest Window ====

The Quest Window or Quest Journal (Opened via Alt+U) allows the player to view all quests their character has started but not yet completed (Except for instance dungeon quests and Battlegrounds instances, which always remain once started).
To place a quest in the Inactive tab, right click once on it and the name will turn gray. It will then appear on the Inactive tab instead of Active. Right clicking the name again will bring it back to the Active tab. Moving the quest back and forth has no effect on whether you can continue it or not.
Not every quest has a quest window component. Those quests who have quest window walkthroughs can be found in this category as well as by having their infobox in gold. Additionally, the Quest Window guides are not comprehensive, and do not specify the exact coordinates of the next NPC or location the player must visit. It is highly recommended to continue using the wiki guides along with the in-game walkthroughs.

[[File:QWindow.jpg|center|caption]]

== Quest Database - Adding Quest ==

=== Structure ===

<pre>Quest ID,Time Limit,Target1,Val1,Target2,Val2,Target3,Val3,Quest Title</pre>

Quest ID - ID of the quest, must increment and should not be duplicated. 
Time Limit - Time limit for the quest to be finish. 
Target 1 - Monster ID. 
Val1 - Value of Monster to be killed. 
Target 2 - Monster ID. 
Val2 - Value of Monster to be killed. 
Target 3 - Monster ID. 
Val3 - Value of Monster to be killed. 
Quest Title - The title of the Quest you made. 

=== Example ===
For this example I will make a quest that will require to kill 10 Poring's.

<pre>65000,0,1002,10,0,0,0,0,"Quest - Poring Hunt"</pre>

==== Client Side Editing ====

You have to edit your questid2display.txt

==== Structure ====
<pre>
QUESTID#Quest Name#FILENAME#LOG_FILENAME#
Summary description#
Objective description#
</pre>

=== Example ===
<pre>
65000#Quest - Poring Hunt#SG_FEEL#QUE_NOIMAGE#
Find the monster named Poring and kill 10#
Hunting 10 Poring#
</pre>

== Quest Log Commands ==

=== Set Quest ===
<pre>*setquest <ID>;</pre>

Place quest of <ID> in the users quest log, the state of which is "active".

=== Example ===
<pre>prontera,xx,xx,4 script SetQuest 51,{
setquest 65000; // This will add the Quest ID 65000 to your Quest Window.
}
</pre>

This sample will add the quest "Quest - Poring Hunt" which I stated on the Adding Quest.
'''Note''': The example is just a simple NPC that will add Quest ID 65000 every time you click it, You can add conditions so that it can only be taken once.

=== Complete Quest ===
<pre>*completequest <ID>;</pre>

Change the state for the given quest <ID> to "complete" and remove from
the users quest log.

=== Example ===
<pre>prontera,xx,xx,4 script CompleteQuest 51,{
completequest 65000; // This will change the state of the quest to "complete"
set zeny,zeny + 100; //just add line like this if you want to give zeny reward if a player finish the quest.
getitem 501,1; //just add line like this if you want to give item reward if a player finish the quest.
}
</pre>

=== Erase Quest ===
<pre>*erasequest <ID>;</pre>

Remove the quest of the given <ID> from the user's quest log.

=== Example ===
<pre>prontera,xx,xx,4 script EraseQuest 51,{
erasequest 65000; // This will remove the quest to your Quest Window.
}
</pre>

=== Change Quest ===
<pre>*changequest <ID>,<ID2>;</pre>

Remove quest of the given <ID> from the user's quest log.
Add quest of the <ID2> to the the quest log, and the state is "active".

=== Example ===
<pre>prontera,xx,xx,4 script ChangeQuest 51,{
changequest 65000,65001; // This will remove the quest ID 65000 and change it to 65001 with the state "active".
}
</pre>

=== Check Quest ===

<pre>*checkquest(<ID>{,PLAYTIME|HUNTING})</pre>

If no additional argument supplied, return the state of the quest:
<pre>
-1 = Quest not started (not in quest log)
0 = Quest has been given, but the state is "inactive"
1 = Quest has been given, and the state is "active"
2 = Quest completed
</pre>

=== Example ===
<pre>prontera,xx,xx,4 script CheckQuest 51,{

if(checkquest(65000) == 0) { //Quest is Inactive
mes "[Jelly]";
mes "Quest is Inactive";
close;
} else if(checkquest(65000) == -1) { //Quest Not started yet
mes "[Jelly]";
mes "Quest Not Started";
close;
} else if(checkquest(65000) == 1) { //Quest is Active
mes "[Jelly]";
mes "Quest is Active!";
close;
} else if(checkquest(65000) == 2) { // Quest finished.
mes "[Jelly]";
mes "Quest Finished!";
completequest 65000;
close;
}
}
</pre>

If parameter "PLAYTIME" is supplied:
<pre>
-1 = Quest not started (not in quest log)
0 = the time limit has not yet been reached
1 = the time limit has not been reached but the quest is marked as complete
2 = the time limit has been reached
</pre>

If parameter "HUNTING" is supplied:
<pre>
-1 = Quest not started (not in quest log)
0 = you haven't killed all of the target monsters and the time limit has not been reached.
1 = you haven't killed all of the target monsters but the time limit has been reached.
2 = you've killed all of the target monsters
</pre>

=== Example | Hunting ===
<pre>prontera,xx,xx,4 script CheckQuest 51,{

if (checkquest(65000,HUNTING) == -1) {
mes "[Jelly]";
mes "Quest not Started",
close;
} else if (checkquest(65000,HUNTING) == 0) {
mes "[Jelly]";
mes "You haven't killed all of the target monsters and the time limit has not been reached.";
close;
} else if (checkquest(65000,HUNTING) == 1) {
mes "[Jelly]";
mes "You haven't killed all of the target monsters but the time limit has been reached.";
close;
} else if (checkquest(65000,HUNTING) == 2) {
completequest 65000;
set zeny,zeny+100; //Zeny Reward
getitem 501,1; // Item Reward
mes "[Jelly]";
mes "Quest Finished";
close;
}
}
</pre>

=== Show Event ===
<pre>
*showevent <state>, <color>;

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.

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.

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.
</pre>

=== Increasing Max Quest DB ===
<pre>
trunk/src/common/mmo.h
</pre>

Find this line and increase the value.
<pre>
#define MAX_QUEST_DB 2410 // Max quests that the server will load
</pre>

Recompile, Cheers!

(If you don't know how to recompile click [[Compiling|Here!]])

[[Category:Script Command]]

Quest Log System

2013-07-03T06:03:45Z

Thanna: /* Increasing Max Quest DB */

Quest Log System

2013-07-03T06:02:06Z

Thanna: Created page with "== Quest Log System == ==== Basic Structure of NPC ==== First of all you must have a knowledge on basic scripting, if not please kindly Click Here!. ===..."

File:QWindow.jpg

2013-07-03T04:16:06Z

Thanna:

Building HPM Plugin for MSVC

2013-06-04T15:43:39Z

Thanna: /* Guide */

This is a guide on how to prepare your MSVC environment for a new [[HPM]] plugin.
= Guide =
1. Go to '''src/plugins/''' folder, create a new '''.c''' file, e.g. '''dance.c''' (this name will be used throughout this guide)
[[File:step1.JPG|center|750px]]
2. Open dance.c and paste this code

<pre>
#include <stdio.h>
#include <string.h>
#include "../common/HPMi.h"
#include "../map/script.h"
#include "../map/pc.h"

HPExport struct hplugin_info pinfo =
{
"@dance", // Plugin name
SERVER_TYPE_MAP,// Which server types this plugin works with?
"0.1a", // Plugin version
HPM_VERSION, // HPM Version (don't change, macro is automatically updated)
};

ACMD(dance)
{

if (!message || !*message) {
clif->message(fd, "usage: @dance 1-9");
return -1;
}
if ( atoi(message) == 1 ) {
clif->specialeffect(&sd->bl, 413, ALL_CLIENT);
} else if ( atoi(message) == 2 ) {
clif->specialeffect(&sd->bl, 414, ALL_CLIENT);
} else if ( atoi(message) == 3 ) {
clif->specialeffect(&sd->bl, 415, ALL_CLIENT);
} else if ( atoi(message) == 4 ) {
clif->specialeffect(&sd->bl, 426, ALL_CLIENT);
} else if ( atoi(message) == 5 ) {
clif->specialeffect(&sd->bl, 458, ALL_CLIENT);
} else if ( atoi(message) == 6 ) {
clif->specialeffect(&sd->bl, 466, ALL_CLIENT);
} else if ( atoi(message) == 7 ) {
clif->specialeffect(&sd->bl, 501, ALL_CLIENT);
} else if ( atoi(message) == 8 ) {
clif->specialeffect(&sd->bl, 540, ALL_CLIENT);
} else if ( atoi(message) == 9 ) {
clif->specialeffect(&sd->bl, 550, ALL_CLIENT);
}
else
{
clif->message(fd, "usage: @dance 1-9");
}
return true;
}

/* Server Startup */
HPExport void plugin_init (void)
{
clif = GET_SYMBOL("clif");
script = GET_SYMBOL("script");
skill = GET_SYMBOL("skill");

HPMi->addCommand("dance",ACMD_A(dance));
}
</pre>
3. Open your MSVC project (e.g. '''Hercules-10.sln'')
[[File:step2.JPG|center|750px]]
4. Go to the '''Solution Explorer'''
[[File:step3.JPG|center|750px]]
5. Right click the Hercules project (first item in '''Solution Explorer'''), and click '''Add->New Project'''
[[File:step4.JPG|center|750px]]
6. Select '''General''', and pick '''Empty Project'''.
[[File:step5.JPG|center|750px]]
7. Enter the name of your plugin in the '''Name''' field, and click OK. 

8. In the solution explorer it'll display the new project.
[[File:step6.JPG|center|750px]]
9. Right click the new project, and open '''Add->Existing Item'''
[[File:step7.JPG|center|750px]]
10. Browse to '''src/plugins/''' and select the '''dance.c''' file, and hit OK.
[[File:step8.JPG|center|750px]]
11. It will place the '''dance.c''' file under the '''Source Files''' folder, drag it to the project you created and drop it (in a manner it be placed out of the source files folder.)
[[File:step9.JPG|center|750px]]
(It should look like the image below)
[[File:step10.JPG|center|750px]]
12. With the '''dance.c''' out of the folders, delete the 3 of them (select the 3, hit delete, hit ok)
[[File:step11.JPG|center|750px]]
(It should look like the image below)
[[File:step12.JPG|center|750px]]
13. Right click the project you created, open '''Properties'''
[[File:step13.JPG|center|750px]]
14. Under '''Configuration Properties''' click '''General''', change '''Output Directory''' to '''..\plugins''', '''Intermediate Directory''' to '''$(ProjectName)\$(ConfigurationName)''' and '''Configuration Type''' to '''Dynamic Library (.dll)'''
[[File:step14.JPG|center|750px]]
15. Under '''Configuration Properties''' click '''C/C++''' and open '''General''', change '''Additional Include Directories''' to '''..\src\common;..\3rdparty\msinttypes\include'''
[[File:step15.JPG|center|750px]]
16. Under '''Configuration Properties''' click '''Linker''' and open '''General''', change '''Output File''' to '''$(OutDir)\dance.dll''' (change dance.dll with your actual name, if you used a different one)
[[File:step16.JPG|center|750px]]
17. Done, just add your code to the '''dance.c''' file, and then right-click the project you created, and select '''Build'''

= Notes =
* This guide is probably the worst I've ever written, if you can do better please hit the 'Edit' button, will be most welcome. - Ind
* I used MSVC 2008 when testing this guide.

= New Note =
* Sorry for editing this page, I added step by step images for other people to follow so they can easily follow one of the best feature Hercules have, the HPM. - Thanna
* The tutorial is tested on MSVC 2010.

Building HPM Plugin for MSVC

2013-06-03T16:55:35Z

Thanna: /* Notes */

This is a guide on how to prepare your MSVC environment for a new [[HPM]] plugin.
= Guide =
1. Go to '''src/plugins/''' folder, create a new '''.c''' file, e.g. '''dance.c''' (this name will be used throughout this guide)
[[File:step1.JPG|center|750px]]
2. Open dance.c and paste this code

<pre>
#include <stdio.h>
#include <string.h>
#include "../common/HPMi.h"
#include "../map/script.h"
#include "../map/pc.h"

HPExport struct hplugin_info pinfo =
{
"@dance", // Plugin name
SERVER_TYPE_MAP,// Which server types this plugin works with?
"0.1a", // Plugin version
HPM_VERSION, // HPM Version (don't change, macro is automatically updated)
};

ACMD(dance)
{

if (!message || !*message) {
clif->message(fd, "usage: @dance 1-9");
return -1;
}
if ( atoi(message) == 1 ) {
clif->specialeffect(&sd->bl, 413, ALL_CLIENT);
} else if ( atoi(message) == 2 ) {
clif->specialeffect(&sd->bl, 414, ALL_CLIENT);
} else if ( atoi(message) == 3 ) {
clif->specialeffect(&sd->bl, 415, ALL_CLIENT);
} else if ( atoi(message) == 4 ) {
clif->specialeffect(&sd->bl, 426, ALL_CLIENT);
} else if ( atoi(message) == 5 ) {
clif->specialeffect(&sd->bl, 458, ALL_CLIENT);
} else if ( atoi(message) == 6 ) {
clif->specialeffect(&sd->bl, 466, ALL_CLIENT);
} else if ( atoi(message) == 7 ) {
clif->specialeffect(&sd->bl, 501, ALL_CLIENT);
} else if ( atoi(message) == 8 ) {
clif->specialeffect(&sd->bl, 540, ALL_CLIENT);
} else if ( atoi(message) == 9 ) {
clif->specialeffect(&sd->bl, 550, ALL_CLIENT);
}
return true;
}

/* Server Startup */
HPExport void plugin_init (void)
{
clif = GET_SYMBOL("clif");
script = GET_SYMBOL("script");
skill = GET_SYMBOL("skill");

HPMi->addCommand("dance",ACMD_A(dance));
}
</pre>
3. Open your MSVC project (e.g. '''Hercules-10.sln'')
[[File:step2.JPG|center|750px]]
4. Go to the '''Solution Explorer'''
[[File:step3.JPG|center|750px]]
5. Right click the Hercules project (first item in '''Solution Explorer'''), and click '''Add->New Project'''
[[File:step4.JPG|center|750px]]
6. Select '''General''', and pick '''Empty Project'''.
[[File:step5.JPG|center|750px]]
7. Enter the name of your plugin in the '''Name''' field, and click OK. 

8. In the solution explorer it'll display the new project.
[[File:step6.JPG|center|750px]]
9. Right click the new project, and open '''Add->Existing Item'''
[[File:step7.JPG|center|750px]]
10. Browse to '''src/plugins/''' and select the '''dance.c''' file, and hit OK.
[[File:step8.JPG|center|750px]]
11. It will place the '''dance.c''' file under the '''Source Files''' folder, drag it to the project you created and drop it (in a manner it be placed out of the source files folder.)
[[File:step9.JPG|center|750px]]
(It should look like the image below)
[[File:step10.JPG|center|750px]]
12. With the '''dance.c''' out of the folders, delete the 3 of them (select the 3, hit delete, hit ok)
[[File:step11.JPG|center|750px]]
(It should look like the image below)
[[File:step12.JPG|center|750px]]
13. Right click the project you created, open '''Properties'''
[[File:step13.JPG|center|750px]]
14. Under '''Configuration Properties''' click '''General''', change '''Output Directory''' to '''..\plugins''', '''Intermediate Directory''' to '''$(ProjectName)\$(ConfigurationName)''' and '''Configuration Type''' to '''Dynamic Library (.dll)'''
[[File:step14.JPG|center|750px]]
15. Under '''Configuration Properties''' click '''C/C++''' and open '''General''', change '''Additional Include Directories''' to '''..\src\common;..\3rdparty\msinttypes\include'''
[[File:step15.JPG|center|750px]]
16. Under '''Configuration Properties''' click '''Linker''' and open '''General''', change '''Output File''' to '''$(OutDir)\dance.dll''' (change dance.dll with your actual name, if you used a different one)
[[File:step16.JPG|center|750px]]
17. Done, just add your code to the '''dance.c''' file, and then right-click the project you created, and select '''Build'''

= Notes =
* This guide is probably the worst I've ever written, if you can do better please hit the 'Edit' button, will be most welcome. - Ind
* I used MSVC 2008 when testing this guide.

= New Note =
* Sorry for editing this page, I added step by step images for other people to follow so they can easily follow one of the best feature Hercules have, the HPM. - Thanna
* The tutorial is tested on MSVC 2010.

Building HPM Plugin for MSVC

2013-06-03T16:52:05Z

Thanna: /* Guide */

This is a guide on how to prepare your MSVC environment for a new [[HPM]] plugin.
= Guide =
1. Go to '''src/plugins/''' folder, create a new '''.c''' file, e.g. '''dance.c''' (this name will be used throughout this guide)
[[File:step1.JPG|center|750px]]
2. Open dance.c and paste this code

<pre>
#include <stdio.h>
#include <string.h>
#include "../common/HPMi.h"
#include "../map/script.h"
#include "../map/pc.h"

HPExport struct hplugin_info pinfo =
{
"@dance", // Plugin name
SERVER_TYPE_MAP,// Which server types this plugin works with?
"0.1a", // Plugin version
HPM_VERSION, // HPM Version (don't change, macro is automatically updated)
};

ACMD(dance)
{

if (!message || !*message) {
clif->message(fd, "usage: @dance 1-9");
return -1;
}
if ( atoi(message) == 1 ) {
clif->specialeffect(&sd->bl, 413, ALL_CLIENT);
} else if ( atoi(message) == 2 ) {
clif->specialeffect(&sd->bl, 414, ALL_CLIENT);
} else if ( atoi(message) == 3 ) {
clif->specialeffect(&sd->bl, 415, ALL_CLIENT);
} else if ( atoi(message) == 4 ) {
clif->specialeffect(&sd->bl, 426, ALL_CLIENT);
} else if ( atoi(message) == 5 ) {
clif->specialeffect(&sd->bl, 458, ALL_CLIENT);
} else if ( atoi(message) == 6 ) {
clif->specialeffect(&sd->bl, 466, ALL_CLIENT);
} else if ( atoi(message) == 7 ) {
clif->specialeffect(&sd->bl, 501, ALL_CLIENT);
} else if ( atoi(message) == 8 ) {
clif->specialeffect(&sd->bl, 540, ALL_CLIENT);
} else if ( atoi(message) == 9 ) {
clif->specialeffect(&sd->bl, 550, ALL_CLIENT);
}
return true;
}

/* Server Startup */
HPExport void plugin_init (void)
{
clif = GET_SYMBOL("clif");
script = GET_SYMBOL("script");
skill = GET_SYMBOL("skill");

HPMi->addCommand("dance",ACMD_A(dance));
}
</pre>
3. Open your MSVC project (e.g. '''Hercules-10.sln'')
[[File:step2.JPG|center|750px]]
4. Go to the '''Solution Explorer'''
[[File:step3.JPG|center|750px]]
5. Right click the Hercules project (first item in '''Solution Explorer'''), and click '''Add->New Project'''
[[File:step4.JPG|center|750px]]
6. Select '''General''', and pick '''Empty Project'''.
[[File:step5.JPG|center|750px]]
7. Enter the name of your plugin in the '''Name''' field, and click OK. 

8. In the solution explorer it'll display the new project.
[[File:step6.JPG|center|750px]]
9. Right click the new project, and open '''Add->Existing Item'''
[[File:step7.JPG|center|750px]]
10. Browse to '''src/plugins/''' and select the '''dance.c''' file, and hit OK.
[[File:step8.JPG|center|750px]]
11. It will place the '''dance.c''' file under the '''Source Files''' folder, drag it to the project you created and drop it (in a manner it be placed out of the source files folder.)
[[File:step9.JPG|center|750px]]
(It should look like the image below)
[[File:step10.JPG|center|750px]]
12. With the '''dance.c''' out of the folders, delete the 3 of them (select the 3, hit delete, hit ok)
[[File:step11.JPG|center|750px]]
(It should look like the image below)
[[File:step12.JPG|center|750px]]
13. Right click the project you created, open '''Properties'''
[[File:step13.JPG|center|750px]]
14. Under '''Configuration Properties''' click '''General''', change '''Output Directory''' to '''..\plugins''', '''Intermediate Directory''' to '''$(ProjectName)\$(ConfigurationName)''' and '''Configuration Type''' to '''Dynamic Library (.dll)'''
[[File:step14.JPG|center|750px]]
15. Under '''Configuration Properties''' click '''C/C++''' and open '''General''', change '''Additional Include Directories''' to '''..\src\common;..\3rdparty\msinttypes\include'''
[[File:step15.JPG|center|750px]]
16. Under '''Configuration Properties''' click '''Linker''' and open '''General''', change '''Output File''' to '''$(OutDir)\dance.dll''' (change dance.dll with your actual name, if you used a different one)
[[File:step16.JPG|center|750px]]
17. Done, just add your code to the '''dance.c''' file, and then right-click the project you created, and select '''Build'''

= Notes =
* This guide is probably the worst I've ever written, if you can do better please hit the 'Edit' button, will be most welcome. - Ind
* I used MSVC 2008 when testing this guide.

File:Step16.JPG

2013-06-03T16:22:36Z

Thanna:

File:Step15.JPG

2013-06-03T16:22:13Z

Thanna:

File:Step14.JPG

2013-06-03T16:21:51Z

Thanna:

File:Step13.JPG

2013-06-03T16:21:22Z

Thanna:

File:Step12.JPG

2013-06-03T16:20:54Z

Thanna:

File:Step11.JPG

2013-06-03T16:20:27Z

Thanna:

File:Step10.JPG

2013-06-03T16:19:38Z

Thanna:

File:Step9.JPG

2013-06-03T16:19:12Z

Thanna:

File:Step8.JPG

2013-06-03T16:18:48Z

Thanna:

File:Step7.JPG

2013-06-03T16:18:19Z

Thanna:

File:Step6.JPG

2013-06-03T16:17:51Z

Thanna:

File:Step5.JPG

2013-06-03T16:17:23Z

Thanna:

File:Step4.JPG

2013-06-03T16:16:48Z

Thanna:

File:Step3.JPG

2013-06-03T16:16:15Z

Thanna:

File:Step2.JPG

2013-06-03T16:15:13Z

Thanna:

File:Step1.JPG

2013-06-03T16:14:27Z

Thanna: