Hercules Wiki - User contributions [en]

Tips and Tricks (Scripting)

2014-11-25T03:34:18Z

GmOcean: /* Dynamic Menu */

= Introduction =
This article will go indepth on various ways to script smartly and optimize your scripts. There is no real manual to use this article, besides reading it all, and trying to remember.

= Tips =
== If-Statements ==
There are several ways to make your if-statements function better and faster, and make them more readable at the same time.
=== Use the switch statement: ===
Let's say we had the following code:
if(getarg(1) == 0) cutin "kafra_06",2;
if(getarg(1) == 1) cutin "kafra_05",2;
if(getarg(1) == 2) cutin "kafra_04",2;
if(getarg(1) == 3) cutin "kafra_03",2;
if(getarg(1) == 4) cutin "kafra_02",2;
if(getarg(1) == 5) cutin "kafra_01",2;
if(getarg(1) == 6) cutin "kafra_09",2;
if(getarg(1) == 7) cutin "kafra_08",2;
if(getarg(1) == 8) cutin "kafra_09",2;
We could replace that entire block by the switch command. This commands looks up the value that is provided, and jumps to the according case. Don't worry, if it isn't clear yet, let's go to the replacement code first:
switch(getarg(1)){
case 1: cutin "kafra_05",2; break;
case 2: cutin "kafra_04",2; break;
case 3: cutin "kafra_03",2; break;
case 4: cutin "kafra_02",2; break;
case 5: cutin "kafra_01",2; break;
case 6: cutin "kafra_09",2; break;
case 7: cutin "kafra_08",2; break;
case 8: cutin "kafra_09",2; break;
default: cutin "kafra_06",2; break;
}
As you can see, each if-line has been replaced by a case-line. The command switch looks up the value of getarg(1). If this would be 5, then it would jump to "case 5", do the cutin, and then break. Break makes it jump to after the right curly bracket ('}'). 
If it finds getarg(1) to be 8, it jumps to "case 8", and does the same there. And the best part of the switch statement might be the default one. It kind of replaces the following really unoptimized line:
if(getarg(1) != 1 && getarg(1) != 2 && getarg(1) != 3 .... && getarg(1) != 8) cutin "kafra_06",2;
In English, this means, if the value of getarg(1) does not have an accompanied case, it will jump to the default label.

=== Use the brackets if you're executing more than 1 statement in 'if' statements. ===
If you have a piece of code, that needs to check for a condition, and do multiple things, then you can make it so, that you only have to use one if-line, instead of 4, 5, 1000 or something else. To do this, you will have to use the curly brackets. They tell the script engine that everything between the curly brackets belongs to the command before the left curly bracket. For example, take the following unoptimized code:
if(@var == 1) mes "haha";
if(@var == 1) mes "heha";
if(@var == 1) mes "hiha";
if(@var == 1) mes "hoha";
if(@var == 1) mes "huha";
This can be replaced by the following:
if(@var == 1){
mes "haha";
mes "heha";
mes "hiha";
mes "hoha";
mes "huha";
}
What is so optimized about this? Well, in this case, you can easily see that each if-statement is completely the same, but keep in mind, that the script engine needs to do each if-statement each time it sees one. So, in the top part, it needs to do 5 checks. In the replacement, it only has to do one single check. Based on that check, it either executes the code between the { and } or skips to right after the }. 
Also, from a writer's point of view, this is exactly the same for you. You see in one glance that the entire part between the curly brackets belongs to the if(@var == 1) statement, so you do not have to check each if-statement individually to see that they are all the same.

=== Use if...else if you're not expecting more than 2 values. ===
When you evaluate if a variable meets a certain condition, and you need to do something when that condition is true, and something differently when the condition is false, then you really want to use the if...else combination. This does not only make it more clear for yourself, but also faster for the script engine, because it only needs to evaluate one if-statement instead of two. Take this unoptimized piece of code for example:
@win = rand(2); // Generates 1 or 0
if(@win == 1){
mes "You win!";
}
if(@win == 0){
mes "You lose!";
}

This can be replaced by the following piece of code:
@win = rand(2);
if(@win == 1){
mes "You win!";
} else {
mes "You lose!";
}

== Variable Use ==
A lot of people do not pay any attention when it comes to using variables. They randomly choose a type of variable and use it, or even use a variable when it isn't needed. You must keep in mind though, that Hercules has a limited amount of variables it can use, for (global) account and permanent player variables. Therefor, you want to minimize the use of it. This section will contain some examples of how to minimize that use.

=== Use binary methods to store large number of flags (1 and 0). ===
What a lot of people do not know, is that a single variable can store up to 32 different flags, or values. And with this, I do not mean the use of an array, but really a single variable. This comes in very handy when you are only using a 1 or 0, for example: "@win = 1;". In a normal situation, you can only win or lose, so it can only be a 1 or 0. 
But, let's see how this translates into normal code: 

Bad code -
flag1 = 1;
flag2 = 1;
flag3 = 0;
flag4 = 1;
flag5 = 0;
if (flag1) mes "flag1 is checked";

Good code -
flags = 26; // (equivalent to: 16|8|0|2|0 [binary 11010])
if (flags&16) mes "flag1 is checked"; // 11010 & 10000 > 0 (10000)
As you can see, only one variable used instead of 5, and it contains all the values of those five variables. (In this case, it is also a lot shorter, but that doesn't have to be the case.) 

Note: 
Using binary methods to store variables require that you have at least some knowledge on how to use binary values. This is what you may call advanced scripting, so it is quite normal if you do not understand it right away.

== Infinite For Loops ==
By nature, the Athena Scripting Engine has a limit on the amount of loops that can go through in a specific amount of time, thus halting the script to eliminate the ever dreadful 'Infinite Loop'. However, there is a way around this:

This script below, would actually halt around 682 give or take a few loops, due to preventions on infinite loops.
for (.@a = 0; .@a < 10000; .@a++) {
debugmes .@a;
}

This method used below slows the processes down by a millisecond. This works because each time 'sleep' or 'sleep2' is used, the script's gotocount is reset.
// Supposing you have 10,000 entries... let .@b = Total Entries, .@a is your splicing filter every 500 entries
while (.@b < 10000) {
for (.@a = .@b; .@a < (.@b + 500); .@a++) {
debugmes .@a;
}
.@b = .@a;
sleep 1;
}

See Also: [[freeloop]]

== While (!getmapxy()) ==
The standard getmapxy() returns 0 if the player is found, and 1 if the player is offline.
By using the !getmapxy() feature, while the value does NOT have a value aka it's 0, loop (player still online and active)
This can also be written while (getmapxy() == 0) { }

while ( !getmapxy(.@map$, .@x, .@y, 0 ) ) {
if ( .@map$ != "prontera" ) { // check the player has warped to other map or not
dispbottom "gone";
end;
}
dispbottom .@x +" "+ .@y; // report the position every N second
sleep2 1000; // pause the script
}
end; // when the player logout, the loops break

== Dynamic Menu ==
These menu's help in many different ways. Perhaps you have an unknown list of items and you want the user to select one. How do you know which item it was? What if you have a menu based on certain criteria? This menu can then change based on the information per player. This is where a dynamic menu can come into play.

The basis of a Dynamic menu is as follows: Knowing what option a player chooses, even though the option chosen may be random.

This is easily done with a small example of a simple (Item Required Warper)

prontera,158,174,4 script MyDynWarper 4_M_ORIENT01,{

// Take Locations
setarray .@maps$[0],"Prontera","Morocc","Geffen","Izlude";
setarray .@mapx[0],158,100,200,300;
setarray .@mapy[0],174,100,200,300;

// Set Items Needed
setarray .@items,501,502,503,504;

// Generate Menu
for (.@a = 0; .@a < getarraysize(.@maps$); .@a++) {
if (countitem(.@items[.@a])) {
.@menu_maps$[getarraysize(.@menu_maps$)] = .@maps$[.@a];
.@menu_index[getarraysize(.@menu_index)] = .@a;
}
}

// Generate the Menu String
.@menu$ = .@menu_maps$[0];
for (.@a = 1; .@a < getarraysize(.@menu_maps$); .@a++) {
.@menu$ = .@menu$ + ":" + .@menu_maps$[.@a];
}

// Query Selection
.@a = select(.@menu$) - 1;

warp .@menu_maps$[.@a], .@mapx[.@a], .@mapy[.@a];
end;

}

== Compact IF Statement ==
While, it looks messy, it can help shorten and quicken simplifed IF/ELSE statements. Example below includes a before and after.

Before:
if ( team == 1 )
mes "You are team Red";
else
mes "You are team Blue";

After:
mes "You are team "+( ( team == 1 )?"Red":"Blue" );
[[Category:Scripting]]

Tips and Tricks (Scripting)

2014-11-25T03:31:29Z

GmOcean: /* Infinite For Loops */

= Introduction =
This article will go indepth on various ways to script smartly and optimize your scripts. There is no real manual to use this article, besides reading it all, and trying to remember.

= Tips =
== If-Statements ==
There are several ways to make your if-statements function better and faster, and make them more readable at the same time.
=== Use the switch statement: ===
Let's say we had the following code:
if(getarg(1) == 0) cutin "kafra_06",2;
if(getarg(1) == 1) cutin "kafra_05",2;
if(getarg(1) == 2) cutin "kafra_04",2;
if(getarg(1) == 3) cutin "kafra_03",2;
if(getarg(1) == 4) cutin "kafra_02",2;
if(getarg(1) == 5) cutin "kafra_01",2;
if(getarg(1) == 6) cutin "kafra_09",2;
if(getarg(1) == 7) cutin "kafra_08",2;
if(getarg(1) == 8) cutin "kafra_09",2;
We could replace that entire block by the switch command. This commands looks up the value that is provided, and jumps to the according case. Don't worry, if it isn't clear yet, let's go to the replacement code first:
switch(getarg(1)){
case 1: cutin "kafra_05",2; break;
case 2: cutin "kafra_04",2; break;
case 3: cutin "kafra_03",2; break;
case 4: cutin "kafra_02",2; break;
case 5: cutin "kafra_01",2; break;
case 6: cutin "kafra_09",2; break;
case 7: cutin "kafra_08",2; break;
case 8: cutin "kafra_09",2; break;
default: cutin "kafra_06",2; break;
}
As you can see, each if-line has been replaced by a case-line. The command switch looks up the value of getarg(1). If this would be 5, then it would jump to "case 5", do the cutin, and then break. Break makes it jump to after the right curly bracket ('}'). 
If it finds getarg(1) to be 8, it jumps to "case 8", and does the same there. And the best part of the switch statement might be the default one. It kind of replaces the following really unoptimized line:
if(getarg(1) != 1 && getarg(1) != 2 && getarg(1) != 3 .... && getarg(1) != 8) cutin "kafra_06",2;
In English, this means, if the value of getarg(1) does not have an accompanied case, it will jump to the default label.

=== Use the brackets if you're executing more than 1 statement in 'if' statements. ===
If you have a piece of code, that needs to check for a condition, and do multiple things, then you can make it so, that you only have to use one if-line, instead of 4, 5, 1000 or something else. To do this, you will have to use the curly brackets. They tell the script engine that everything between the curly brackets belongs to the command before the left curly bracket. For example, take the following unoptimized code:
if(@var == 1) mes "haha";
if(@var == 1) mes "heha";
if(@var == 1) mes "hiha";
if(@var == 1) mes "hoha";
if(@var == 1) mes "huha";
This can be replaced by the following:
if(@var == 1){
mes "haha";
mes "heha";
mes "hiha";
mes "hoha";
mes "huha";
}
What is so optimized about this? Well, in this case, you can easily see that each if-statement is completely the same, but keep in mind, that the script engine needs to do each if-statement each time it sees one. So, in the top part, it needs to do 5 checks. In the replacement, it only has to do one single check. Based on that check, it either executes the code between the { and } or skips to right after the }. 
Also, from a writer's point of view, this is exactly the same for you. You see in one glance that the entire part between the curly brackets belongs to the if(@var == 1) statement, so you do not have to check each if-statement individually to see that they are all the same.

=== Use if...else if you're not expecting more than 2 values. ===
When you evaluate if a variable meets a certain condition, and you need to do something when that condition is true, and something differently when the condition is false, then you really want to use the if...else combination. This does not only make it more clear for yourself, but also faster for the script engine, because it only needs to evaluate one if-statement instead of two. Take this unoptimized piece of code for example:
@win = rand(2); // Generates 1 or 0
if(@win == 1){
mes "You win!";
}
if(@win == 0){
mes "You lose!";
}

This can be replaced by the following piece of code:
@win = rand(2);
if(@win == 1){
mes "You win!";
} else {
mes "You lose!";
}

== Variable Use ==
A lot of people do not pay any attention when it comes to using variables. They randomly choose a type of variable and use it, or even use a variable when it isn't needed. You must keep in mind though, that Hercules has a limited amount of variables it can use, for (global) account and permanent player variables. Therefor, you want to minimize the use of it. This section will contain some examples of how to minimize that use.

=== Use binary methods to store large number of flags (1 and 0). ===
What a lot of people do not know, is that a single variable can store up to 32 different flags, or values. And with this, I do not mean the use of an array, but really a single variable. This comes in very handy when you are only using a 1 or 0, for example: "@win = 1;". In a normal situation, you can only win or lose, so it can only be a 1 or 0. 
But, let's see how this translates into normal code: 

Bad code -
flag1 = 1;
flag2 = 1;
flag3 = 0;
flag4 = 1;
flag5 = 0;
if (flag1) mes "flag1 is checked";

Good code -
flags = 26; // (equivalent to: 16|8|0|2|0 [binary 11010])
if (flags&16) mes "flag1 is checked"; // 11010 & 10000 > 0 (10000)
As you can see, only one variable used instead of 5, and it contains all the values of those five variables. (In this case, it is also a lot shorter, but that doesn't have to be the case.) 

Note: 
Using binary methods to store variables require that you have at least some knowledge on how to use binary values. This is what you may call advanced scripting, so it is quite normal if you do not understand it right away.

== Infinite For Loops ==
By nature, the Athena Scripting Engine has a limit on the amount of loops that can go through in a specific amount of time, thus halting the script to eliminate the ever dreadful 'Infinite Loop'. However, there is a way around this:

This script below, would actually halt around 682 give or take a few loops, due to preventions on infinite loops.
for (.@a = 0; .@a < 10000; .@a++) {
debugmes .@a;
}

This method used below slows the processes down by a millisecond. This works because each time 'sleep' or 'sleep2' is used, the script's gotocount is reset.
// Supposing you have 10,000 entries... let .@b = Total Entries, .@a is your splicing filter every 500 entries
while (.@b < 10000) {
for (.@a = .@b; .@a < (.@b + 500); .@a++) {
debugmes .@a;
}
.@b = .@a;
sleep 1;
}

See Also: [[freeloop]]

== While (!getmapxy()) ==
The standard getmapxy() returns 0 if the player is found, and 1 if the player is offline.
By using the !getmapxy() feature, while the value does NOT have a value aka it's 0, loop (player still online and active)
This can also be written while (getmapxy() == 0) { }

while ( !getmapxy(.@map$, .@x, .@y, 0 ) ) {
if ( .@map$ != "prontera" ) { // check the player has warped to other map or not
dispbottom "gone";
end;
}
dispbottom .@x +" "+ .@y; // report the position every N second
sleep2 1000; // pause the script
}
end; // when the player logout, the loops break

== Dynamic Menu ==
These menu's help in many different ways. Perhaps you have an unknown list of items and you want the user to select one. How do you know which item it was? What if you have a menu based on certain criteria? This menu can then change based on the information per player. This is where a dynamic menu can come into play.

The basis of a Dynamic menu is as follows: Knowing what option a player chooses, even though the option chosen may be random.

This is easily done with a small example of a simple (Item Required Warper)

prontera,158,174,4 script MyDynWarper 88,{

// Take Locations
setarray .@maps$[0],"Prontera","Morocc","Geffen","Izlude";
setarray .@mapx[0],158,100,200,300;
setarray .@mapy[0],174,100,200,300;

// Set Items Needed
setarray .@items,501,502,503,504;

// Generate Menu
for (set .@a, 0; .@a < getarraysize(.@maps$); set .@a, .@a + 1) {
if (countitem(.@items[.@a])) {
set .@menu_maps$[getarraysize(.@menu_maps$)], .@maps$[.@a];
set .@menu_index[getarraysize(.@menu_index)], .@a;
}
}

// Generate the Menu String
set .@menu$, .@menu_maps$[0];
for (set .@a, 1; .@a < getarraysize(.@menu_maps$); set .@a, .@a + 1) {
set .@menu$, .@menu$ + ":" + .@menu_maps$[.@a];
}

// Query Selection
set .@a, select(.@menu$) - 1;

warp .@menu_maps$[.@a], .@mapx[.@a], .@mapy[.@a];
end;

}

== Compact IF Statement ==
While, it looks messy, it can help shorten and quicken simplifed IF/ELSE statements. Example below includes a before and after.

Before:
if ( team == 1 )
mes "You are team Red";
else
mes "You are team Blue";

After:
mes "You are team "+( ( team == 1 )?"Red":"Blue" );
[[Category:Scripting]]

Tips and Tricks (Scripting)

2014-11-25T03:30:12Z

GmOcean: /* Use binary methods to store large number of flags (1 and 0). */

= Introduction =
This article will go indepth on various ways to script smartly and optimize your scripts. There is no real manual to use this article, besides reading it all, and trying to remember.

= Tips =
== If-Statements ==
There are several ways to make your if-statements function better and faster, and make them more readable at the same time.
=== Use the switch statement: ===
Let's say we had the following code:
if(getarg(1) == 0) cutin "kafra_06",2;
if(getarg(1) == 1) cutin "kafra_05",2;
if(getarg(1) == 2) cutin "kafra_04",2;
if(getarg(1) == 3) cutin "kafra_03",2;
if(getarg(1) == 4) cutin "kafra_02",2;
if(getarg(1) == 5) cutin "kafra_01",2;
if(getarg(1) == 6) cutin "kafra_09",2;
if(getarg(1) == 7) cutin "kafra_08",2;
if(getarg(1) == 8) cutin "kafra_09",2;
We could replace that entire block by the switch command. This commands looks up the value that is provided, and jumps to the according case. Don't worry, if it isn't clear yet, let's go to the replacement code first:
switch(getarg(1)){
case 1: cutin "kafra_05",2; break;
case 2: cutin "kafra_04",2; break;
case 3: cutin "kafra_03",2; break;
case 4: cutin "kafra_02",2; break;
case 5: cutin "kafra_01",2; break;
case 6: cutin "kafra_09",2; break;
case 7: cutin "kafra_08",2; break;
case 8: cutin "kafra_09",2; break;
default: cutin "kafra_06",2; break;
}
As you can see, each if-line has been replaced by a case-line. The command switch looks up the value of getarg(1). If this would be 5, then it would jump to "case 5", do the cutin, and then break. Break makes it jump to after the right curly bracket ('}'). 
If it finds getarg(1) to be 8, it jumps to "case 8", and does the same there. And the best part of the switch statement might be the default one. It kind of replaces the following really unoptimized line:
if(getarg(1) != 1 && getarg(1) != 2 && getarg(1) != 3 .... && getarg(1) != 8) cutin "kafra_06",2;
In English, this means, if the value of getarg(1) does not have an accompanied case, it will jump to the default label.

=== Use the brackets if you're executing more than 1 statement in 'if' statements. ===
If you have a piece of code, that needs to check for a condition, and do multiple things, then you can make it so, that you only have to use one if-line, instead of 4, 5, 1000 or something else. To do this, you will have to use the curly brackets. They tell the script engine that everything between the curly brackets belongs to the command before the left curly bracket. For example, take the following unoptimized code:
if(@var == 1) mes "haha";
if(@var == 1) mes "heha";
if(@var == 1) mes "hiha";
if(@var == 1) mes "hoha";
if(@var == 1) mes "huha";
This can be replaced by the following:
if(@var == 1){
mes "haha";
mes "heha";
mes "hiha";
mes "hoha";
mes "huha";
}
What is so optimized about this? Well, in this case, you can easily see that each if-statement is completely the same, but keep in mind, that the script engine needs to do each if-statement each time it sees one. So, in the top part, it needs to do 5 checks. In the replacement, it only has to do one single check. Based on that check, it either executes the code between the { and } or skips to right after the }. 
Also, from a writer's point of view, this is exactly the same for you. You see in one glance that the entire part between the curly brackets belongs to the if(@var == 1) statement, so you do not have to check each if-statement individually to see that they are all the same.

=== Use if...else if you're not expecting more than 2 values. ===
When you evaluate if a variable meets a certain condition, and you need to do something when that condition is true, and something differently when the condition is false, then you really want to use the if...else combination. This does not only make it more clear for yourself, but also faster for the script engine, because it only needs to evaluate one if-statement instead of two. Take this unoptimized piece of code for example:
@win = rand(2); // Generates 1 or 0
if(@win == 1){
mes "You win!";
}
if(@win == 0){
mes "You lose!";
}

This can be replaced by the following piece of code:
@win = rand(2);
if(@win == 1){
mes "You win!";
} else {
mes "You lose!";
}

== Variable Use ==
A lot of people do not pay any attention when it comes to using variables. They randomly choose a type of variable and use it, or even use a variable when it isn't needed. You must keep in mind though, that Hercules has a limited amount of variables it can use, for (global) account and permanent player variables. Therefor, you want to minimize the use of it. This section will contain some examples of how to minimize that use.

=== Use binary methods to store large number of flags (1 and 0). ===
What a lot of people do not know, is that a single variable can store up to 32 different flags, or values. And with this, I do not mean the use of an array, but really a single variable. This comes in very handy when you are only using a 1 or 0, for example: "@win = 1;". In a normal situation, you can only win or lose, so it can only be a 1 or 0. 
But, let's see how this translates into normal code: 

Bad code -
flag1 = 1;
flag2 = 1;
flag3 = 0;
flag4 = 1;
flag5 = 0;
if (flag1) mes "flag1 is checked";

Good code -
flags = 26; // (equivalent to: 16|8|0|2|0 [binary 11010])
if (flags&16) mes "flag1 is checked"; // 11010 & 10000 > 0 (10000)
As you can see, only one variable used instead of 5, and it contains all the values of those five variables. (In this case, it is also a lot shorter, but that doesn't have to be the case.) 

Note: 
Using binary methods to store variables require that you have at least some knowledge on how to use binary values. This is what you may call advanced scripting, so it is quite normal if you do not understand it right away.

== Infinite For Loops ==
By nature, the Athena Scripting Engine has a limit on the amount of loops that can go through in a specific amount of time, thus halting the script to eliminate the ever dreadful 'Infinite Loop'. However, there is a way around this:

This script below, would actually halt around 682 give or take a few loops, due to preventions on infinite loops.
for (set .@a, 0; .@a < 10000; set .@a, .@a + 1) {
debugmes .@a;
}

This method used below slows the processes down by a millisecond. This works because each time 'sleep' or 'sleep2' is used, the script's gotocount is reset.
// Supposing you have 10,000 entries... let .@b = Total Entries, .@a is your splicing filter every 500 entries
while (.@b < 10000) {
for (set .@a, .@b; .@a < .@b + 500; set .@a, .@a + 1) {
debugmes .@a;
}
set .@b, .@a;
sleep 1;
}

See Also: [[freeloop]]

== While (!getmapxy()) ==
The standard getmapxy() returns 0 if the player is found, and 1 if the player is offline.
By using the !getmapxy() feature, while the value does NOT have a value aka it's 0, loop (player still online and active)
This can also be written while (getmapxy() == 0) { }

while ( !getmapxy(.@map$, .@x, .@y, 0 ) ) {
if ( .@map$ != "prontera" ) { // check the player has warped to other map or not
dispbottom "gone";
end;
}
dispbottom .@x +" "+ .@y; // report the position every N second
sleep2 1000; // pause the script
}
end; // when the player logout, the loops break

== Dynamic Menu ==
These menu's help in many different ways. Perhaps you have an unknown list of items and you want the user to select one. How do you know which item it was? What if you have a menu based on certain criteria? This menu can then change based on the information per player. This is where a dynamic menu can come into play.

The basis of a Dynamic menu is as follows: Knowing what option a player chooses, even though the option chosen may be random.

This is easily done with a small example of a simple (Item Required Warper)

prontera,158,174,4 script MyDynWarper 88,{

// Take Locations
setarray .@maps$[0],"Prontera","Morocc","Geffen","Izlude";
setarray .@mapx[0],158,100,200,300;
setarray .@mapy[0],174,100,200,300;

// Set Items Needed
setarray .@items,501,502,503,504;

// Generate Menu
for (set .@a, 0; .@a < getarraysize(.@maps$); set .@a, .@a + 1) {
if (countitem(.@items[.@a])) {
set .@menu_maps$[getarraysize(.@menu_maps$)], .@maps$[.@a];
set .@menu_index[getarraysize(.@menu_index)], .@a;
}
}

// Generate the Menu String
set .@menu$, .@menu_maps$[0];
for (set .@a, 1; .@a < getarraysize(.@menu_maps$); set .@a, .@a + 1) {
set .@menu$, .@menu$ + ":" + .@menu_maps$[.@a];
}

// Query Selection
set .@a, select(.@menu$) - 1;

warp .@menu_maps$[.@a], .@mapx[.@a], .@mapy[.@a];
end;

}

== Compact IF Statement ==
While, it looks messy, it can help shorten and quicken simplifed IF/ELSE statements. Example below includes a before and after.

Before:
if ( team == 1 )
mes "You are team Red";
else
mes "You are team Blue";

After:
mes "You are team "+( ( team == 1 )?"Red":"Blue" );
[[Category:Scripting]]

Tips and Tricks (Scripting)

2014-11-25T03:28:18Z

GmOcean: /* Use if...else if you're not expecting more than 2 values. */

= Introduction =
This article will go indepth on various ways to script smartly and optimize your scripts. There is no real manual to use this article, besides reading it all, and trying to remember.

= Tips =
== If-Statements ==
There are several ways to make your if-statements function better and faster, and make them more readable at the same time.
=== Use the switch statement: ===
Let's say we had the following code:
if(getarg(1) == 0) cutin "kafra_06",2;
if(getarg(1) == 1) cutin "kafra_05",2;
if(getarg(1) == 2) cutin "kafra_04",2;
if(getarg(1) == 3) cutin "kafra_03",2;
if(getarg(1) == 4) cutin "kafra_02",2;
if(getarg(1) == 5) cutin "kafra_01",2;
if(getarg(1) == 6) cutin "kafra_09",2;
if(getarg(1) == 7) cutin "kafra_08",2;
if(getarg(1) == 8) cutin "kafra_09",2;
We could replace that entire block by the switch command. This commands looks up the value that is provided, and jumps to the according case. Don't worry, if it isn't clear yet, let's go to the replacement code first:
switch(getarg(1)){
case 1: cutin "kafra_05",2; break;
case 2: cutin "kafra_04",2; break;
case 3: cutin "kafra_03",2; break;
case 4: cutin "kafra_02",2; break;
case 5: cutin "kafra_01",2; break;
case 6: cutin "kafra_09",2; break;
case 7: cutin "kafra_08",2; break;
case 8: cutin "kafra_09",2; break;
default: cutin "kafra_06",2; break;
}
As you can see, each if-line has been replaced by a case-line. The command switch looks up the value of getarg(1). If this would be 5, then it would jump to "case 5", do the cutin, and then break. Break makes it jump to after the right curly bracket ('}'). 
If it finds getarg(1) to be 8, it jumps to "case 8", and does the same there. And the best part of the switch statement might be the default one. It kind of replaces the following really unoptimized line:
if(getarg(1) != 1 && getarg(1) != 2 && getarg(1) != 3 .... && getarg(1) != 8) cutin "kafra_06",2;
In English, this means, if the value of getarg(1) does not have an accompanied case, it will jump to the default label.

=== Use the brackets if you're executing more than 1 statement in 'if' statements. ===
If you have a piece of code, that needs to check for a condition, and do multiple things, then you can make it so, that you only have to use one if-line, instead of 4, 5, 1000 or something else. To do this, you will have to use the curly brackets. They tell the script engine that everything between the curly brackets belongs to the command before the left curly bracket. For example, take the following unoptimized code:
if(@var == 1) mes "haha";
if(@var == 1) mes "heha";
if(@var == 1) mes "hiha";
if(@var == 1) mes "hoha";
if(@var == 1) mes "huha";
This can be replaced by the following:
if(@var == 1){
mes "haha";
mes "heha";
mes "hiha";
mes "hoha";
mes "huha";
}
What is so optimized about this? Well, in this case, you can easily see that each if-statement is completely the same, but keep in mind, that the script engine needs to do each if-statement each time it sees one. So, in the top part, it needs to do 5 checks. In the replacement, it only has to do one single check. Based on that check, it either executes the code between the { and } or skips to right after the }. 
Also, from a writer's point of view, this is exactly the same for you. You see in one glance that the entire part between the curly brackets belongs to the if(@var == 1) statement, so you do not have to check each if-statement individually to see that they are all the same.

=== Use if...else if you're not expecting more than 2 values. ===
When you evaluate if a variable meets a certain condition, and you need to do something when that condition is true, and something differently when the condition is false, then you really want to use the if...else combination. This does not only make it more clear for yourself, but also faster for the script engine, because it only needs to evaluate one if-statement instead of two. Take this unoptimized piece of code for example:
@win = rand(2); // Generates 1 or 0
if(@win == 1){
mes "You win!";
}
if(@win == 0){
mes "You lose!";
}

This can be replaced by the following piece of code:
@win = rand(2);
if(@win == 1){
mes "You win!";
} else {
mes "You lose!";
}

== Variable Use ==
A lot of people do not pay any attention when it comes to using variables. They randomly choose a type of variable and use it, or even use a variable when it isn't needed. You must keep in mind though, that Hercules has a limited amount of variables it can use, for (global) account and permanent player variables. Therefor, you want to minimize the use of it. This section will contain some examples of how to minimize that use.

=== Use binary methods to store large number of flags (1 and 0). ===
What a lot of people do not know, is that a single variable can store up to 32 different flags, or values. And with this, I do not mean the use of an array, but really a single variable. This comes in very handy when you are only using a 1 or 0, for example: "set @win, 1;". In a normal situation, you can only win or lose, so it can only be a 1 or 0. 
But, let's see how this translates into normal code: 

Bad code -
set flag1, 1;
set flag2, 1;
set flag3, 0;
set flag4, 1;
set flag5, 0;
if(flag1) mes "flag1 is checked";

Good code -
set flags, 26; // (equivalent to: 16|8|0|2|0 [binary 11010])
if(flags&16) mes "flag1 is checked"; // 11010 & 10000 > 0 (10000)
As you can see, only one variable used instead of 5, and it contains all the values of those five variables. (In this case, it is also a lot shorter, but that doesn't have to be the case.) 

Note: 
Using binary methods to store variables require that you have at least some knowledge on how to use binary values. This is what you may call advanced scripting, so it is quite normal if you do not understand it right away.

== Infinite For Loops ==
By nature, the Athena Scripting Engine has a limit on the amount of loops that can go through in a specific amount of time, thus halting the script to eliminate the ever dreadful 'Infinite Loop'. However, there is a way around this:

This script below, would actually halt around 682 give or take a few loops, due to preventions on infinite loops.
for (set .@a, 0; .@a < 10000; set .@a, .@a + 1) {
debugmes .@a;
}

This method used below slows the processes down by a millisecond. This works because each time 'sleep' or 'sleep2' is used, the script's gotocount is reset.
// Supposing you have 10,000 entries... let .@b = Total Entries, .@a is your splicing filter every 500 entries
while (.@b < 10000) {
for (set .@a, .@b; .@a < .@b + 500; set .@a, .@a + 1) {
debugmes .@a;
}
set .@b, .@a;
sleep 1;
}

See Also: [[freeloop]]

== While (!getmapxy()) ==
The standard getmapxy() returns 0 if the player is found, and 1 if the player is offline.
By using the !getmapxy() feature, while the value does NOT have a value aka it's 0, loop (player still online and active)
This can also be written while (getmapxy() == 0) { }

while ( !getmapxy(.@map$, .@x, .@y, 0 ) ) {
if ( .@map$ != "prontera" ) { // check the player has warped to other map or not
dispbottom "gone";
end;
}
dispbottom .@x +" "+ .@y; // report the position every N second
sleep2 1000; // pause the script
}
end; // when the player logout, the loops break

== Dynamic Menu ==
These menu's help in many different ways. Perhaps you have an unknown list of items and you want the user to select one. How do you know which item it was? What if you have a menu based on certain criteria? This menu can then change based on the information per player. This is where a dynamic menu can come into play.

The basis of a Dynamic menu is as follows: Knowing what option a player chooses, even though the option chosen may be random.

This is easily done with a small example of a simple (Item Required Warper)

prontera,158,174,4 script MyDynWarper 88,{

// Take Locations
setarray .@maps$[0],"Prontera","Morocc","Geffen","Izlude";
setarray .@mapx[0],158,100,200,300;
setarray .@mapy[0],174,100,200,300;

// Set Items Needed
setarray .@items,501,502,503,504;

// Generate Menu
for (set .@a, 0; .@a < getarraysize(.@maps$); set .@a, .@a + 1) {
if (countitem(.@items[.@a])) {
set .@menu_maps$[getarraysize(.@menu_maps$)], .@maps$[.@a];
set .@menu_index[getarraysize(.@menu_index)], .@a;
}
}

// Generate the Menu String
set .@menu$, .@menu_maps$[0];
for (set .@a, 1; .@a < getarraysize(.@menu_maps$); set .@a, .@a + 1) {
set .@menu$, .@menu$ + ":" + .@menu_maps$[.@a];
}

// Query Selection
set .@a, select(.@menu$) - 1;

warp .@menu_maps$[.@a], .@mapx[.@a], .@mapy[.@a];
end;

}

== Compact IF Statement ==
While, it looks messy, it can help shorten and quicken simplifed IF/ELSE statements. Example below includes a before and after.

Before:
if ( team == 1 )
mes "You are team Red";
else
mes "You are team Blue";

After:
mes "You are team "+( ( team == 1 )?"Red":"Blue" );
[[Category:Scripting]]

Tips and Tricks (Scripting)

2014-11-25T03:26:59Z

GmOcean: /* Infinite For Loops */

= Introduction =
This article will go indepth on various ways to script smartly and optimize your scripts. There is no real manual to use this article, besides reading it all, and trying to remember.

= Tips =
== If-Statements ==
There are several ways to make your if-statements function better and faster, and make them more readable at the same time.
=== Use the switch statement: ===
Let's say we had the following code:
if(getarg(1) == 0) cutin "kafra_06",2;
if(getarg(1) == 1) cutin "kafra_05",2;
if(getarg(1) == 2) cutin "kafra_04",2;
if(getarg(1) == 3) cutin "kafra_03",2;
if(getarg(1) == 4) cutin "kafra_02",2;
if(getarg(1) == 5) cutin "kafra_01",2;
if(getarg(1) == 6) cutin "kafra_09",2;
if(getarg(1) == 7) cutin "kafra_08",2;
if(getarg(1) == 8) cutin "kafra_09",2;
We could replace that entire block by the switch command. This commands looks up the value that is provided, and jumps to the according case. Don't worry, if it isn't clear yet, let's go to the replacement code first:
switch(getarg(1)){
case 1: cutin "kafra_05",2; break;
case 2: cutin "kafra_04",2; break;
case 3: cutin "kafra_03",2; break;
case 4: cutin "kafra_02",2; break;
case 5: cutin "kafra_01",2; break;
case 6: cutin "kafra_09",2; break;
case 7: cutin "kafra_08",2; break;
case 8: cutin "kafra_09",2; break;
default: cutin "kafra_06",2; break;
}
As you can see, each if-line has been replaced by a case-line. The command switch looks up the value of getarg(1). If this would be 5, then it would jump to "case 5", do the cutin, and then break. Break makes it jump to after the right curly bracket ('}'). 
If it finds getarg(1) to be 8, it jumps to "case 8", and does the same there. And the best part of the switch statement might be the default one. It kind of replaces the following really unoptimized line:
if(getarg(1) != 1 && getarg(1) != 2 && getarg(1) != 3 .... && getarg(1) != 8) cutin "kafra_06",2;
In English, this means, if the value of getarg(1) does not have an accompanied case, it will jump to the default label.

=== Use the brackets if you're executing more than 1 statement in 'if' statements. ===
If you have a piece of code, that needs to check for a condition, and do multiple things, then you can make it so, that you only have to use one if-line, instead of 4, 5, 1000 or something else. To do this, you will have to use the curly brackets. They tell the script engine that everything between the curly brackets belongs to the command before the left curly bracket. For example, take the following unoptimized code:
if(@var == 1) mes "haha";
if(@var == 1) mes "heha";
if(@var == 1) mes "hiha";
if(@var == 1) mes "hoha";
if(@var == 1) mes "huha";
This can be replaced by the following:
if(@var == 1){
mes "haha";
mes "heha";
mes "hiha";
mes "hoha";
mes "huha";
}
What is so optimized about this? Well, in this case, you can easily see that each if-statement is completely the same, but keep in mind, that the script engine needs to do each if-statement each time it sees one. So, in the top part, it needs to do 5 checks. In the replacement, it only has to do one single check. Based on that check, it either executes the code between the { and } or skips to right after the }. 
Also, from a writer's point of view, this is exactly the same for you. You see in one glance that the entire part between the curly brackets belongs to the if(@var == 1) statement, so you do not have to check each if-statement individually to see that they are all the same.

=== Use if...else if you're not expecting more than 2 values. ===
When you evaluate if a variable meets a certain condition, and you need to do something when that condition is true, and something differently when the condition is false, then you really want to use the if...else combination. This does not only make it more clear for yourself, but also faster for the script engine, because it only needs to evaluate one if-statement instead of two. Take this unoptimized piece of code for example:
set @win, rand(2); // Generates 1 or 0
if(@win == 1){
mes "You win!";
}
if(@win == 0){
mes "You lose!";
}

This can be replaced by the following piece of code:
set @win, rand(2);
if(@win == 1){
mes "You win!";
} else {
mes "You lose!";
}

== Variable Use ==
A lot of people do not pay any attention when it comes to using variables. They randomly choose a type of variable and use it, or even use a variable when it isn't needed. You must keep in mind though, that Hercules has a limited amount of variables it can use, for (global) account and permanent player variables. Therefor, you want to minimize the use of it. This section will contain some examples of how to minimize that use.

=== Use binary methods to store large number of flags (1 and 0). ===
What a lot of people do not know, is that a single variable can store up to 32 different flags, or values. And with this, I do not mean the use of an array, but really a single variable. This comes in very handy when you are only using a 1 or 0, for example: "set @win, 1;". In a normal situation, you can only win or lose, so it can only be a 1 or 0. 
But, let's see how this translates into normal code: 

Bad code -
set flag1, 1;
set flag2, 1;
set flag3, 0;
set flag4, 1;
set flag5, 0;
if(flag1) mes "flag1 is checked";

Good code -
set flags, 26; // (equivalent to: 16|8|0|2|0 [binary 11010])
if(flags&16) mes "flag1 is checked"; // 11010 & 10000 > 0 (10000)
As you can see, only one variable used instead of 5, and it contains all the values of those five variables. (In this case, it is also a lot shorter, but that doesn't have to be the case.) 

Note: 
Using binary methods to store variables require that you have at least some knowledge on how to use binary values. This is what you may call advanced scripting, so it is quite normal if you do not understand it right away.

== Infinite For Loops ==
By nature, the Athena Scripting Engine has a limit on the amount of loops that can go through in a specific amount of time, thus halting the script to eliminate the ever dreadful 'Infinite Loop'. However, there is a way around this:

This script below, would actually halt around 682 give or take a few loops, due to preventions on infinite loops.
for (set .@a, 0; .@a < 10000; set .@a, .@a + 1) {
debugmes .@a;
}

This method used below slows the processes down by a millisecond. This works because each time 'sleep' or 'sleep2' is used, the script's gotocount is reset.
// Supposing you have 10,000 entries... let .@b = Total Entries, .@a is your splicing filter every 500 entries
while (.@b < 10000) {
for (set .@a, .@b; .@a < .@b + 500; set .@a, .@a + 1) {
debugmes .@a;
}
set .@b, .@a;
sleep 1;
}

See Also: [[freeloop]]

== While (!getmapxy()) ==
The standard getmapxy() returns 0 if the player is found, and 1 if the player is offline.
By using the !getmapxy() feature, while the value does NOT have a value aka it's 0, loop (player still online and active)
This can also be written while (getmapxy() == 0) { }

while ( !getmapxy(.@map$, .@x, .@y, 0 ) ) {
if ( .@map$ != "prontera" ) { // check the player has warped to other map or not
dispbottom "gone";
end;
}
dispbottom .@x +" "+ .@y; // report the position every N second
sleep2 1000; // pause the script
}
end; // when the player logout, the loops break

== Dynamic Menu ==
These menu's help in many different ways. Perhaps you have an unknown list of items and you want the user to select one. How do you know which item it was? What if you have a menu based on certain criteria? This menu can then change based on the information per player. This is where a dynamic menu can come into play.

The basis of a Dynamic menu is as follows: Knowing what option a player chooses, even though the option chosen may be random.

This is easily done with a small example of a simple (Item Required Warper)

prontera,158,174,4 script MyDynWarper 88,{

// Take Locations
setarray .@maps$[0],"Prontera","Morocc","Geffen","Izlude";
setarray .@mapx[0],158,100,200,300;
setarray .@mapy[0],174,100,200,300;

// Set Items Needed
setarray .@items,501,502,503,504;

// Generate Menu
for (set .@a, 0; .@a < getarraysize(.@maps$); set .@a, .@a + 1) {
if (countitem(.@items[.@a])) {
set .@menu_maps$[getarraysize(.@menu_maps$)], .@maps$[.@a];
set .@menu_index[getarraysize(.@menu_index)], .@a;
}
}

// Generate the Menu String
set .@menu$, .@menu_maps$[0];
for (set .@a, 1; .@a < getarraysize(.@menu_maps$); set .@a, .@a + 1) {
set .@menu$, .@menu$ + ":" + .@menu_maps$[.@a];
}

// Query Selection
set .@a, select(.@menu$) - 1;

warp .@menu_maps$[.@a], .@mapx[.@a], .@mapy[.@a];
end;

}

== Compact IF Statement ==
While, it looks messy, it can help shorten and quicken simplifed IF/ELSE statements. Example below includes a before and after.

Before:
if ( team == 1 )
mes "You are team Red";
else
mes "You are team Blue";

After:
mes "You are team "+( ( team == 1 )?"Red":"Blue" );
[[Category:Scripting]]

Quest Log System

2014-11-16T19:50:28Z

GmOcean: /* Example */

== 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>{,<ID2>};</pre>

Change the state for the given quest <ID> to "complete" and remove from
the users quest log.
 
If a second quest id of greater value is specified, all quests between the two
will be completed.

=== 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>{,<ID2>};</pre>

Remove the quest of the given <ID> from the user's quest log.
 
If a second quest id of greater value is specified, all quests between the two
will be erased.

=== 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 Progress ===

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

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

<pre>*questactive(<ID>)</pre>
Check whether the given quest is in its active state.
Returns true if the quest is active, false otherwise (quest not started, inactive or completed)

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

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

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

If parameter "HUNTING" is supplied:
<pre>
0 = Quest not started (not in quest log)
1 = Player hasn't killed all of the target monsters
2 = Player has killed all of the target monsters
</pre>

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

if (!questprogress(65000,HUNTING)) {
mes "[Jelly]";
mes "Quest not Started",
close;
} else if (questprogress(65000,HUNTING) == 1) {
mes "[Jelly]";
mes "You haven't killed all of the target monsters.";
close;
} else if (questprogress(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/map/quest.h
</pre>

Find this line and increase the value.
<pre>
#define MAX_QUEST_DB (60355+1) // Highest quest ID + 1
</pre>

Recompile, Cheers!

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

[[Category:Script Command]]

Quest Log System

2014-10-28T01:07:44Z

GmOcean: /* Example | Hunting */

== 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 Progress ===

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

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

<pre>*questactive(<ID>)</pre>
Check whether the given quest is in its active state.
Returns true if the quest is active, false otherwise (quest not started, inactive or completed)

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

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

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

If parameter "HUNTING" is supplied:
<pre>
0 = Quest not started (not in quest log)
1 = Player hasn't killed all of the target monsters
2 = Player has killed all of the target monsters
</pre>

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

if (!questprogress(65000,HUNTING)) {
mes "[Jelly]";
mes "Quest not Started",
close;
} else if (questprogress(65000,HUNTING) == 1) {
mes "[Jelly]";
mes "You haven't killed all of the target monsters.";
close;
} else if (questprogress(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/map/quest.h
</pre>

Find this line and increase the value.
<pre>
#define MAX_QUEST_DB (60355+1) // Highest quest ID + 1
</pre>

Recompile, Cheers!

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

[[Category:Script Command]]

Quest Log System

2014-10-28T01:04:46Z

GmOcean: /* Example */

== 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 Progress ===

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

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

<pre>*questactive(<ID>)</pre>
Check whether the given quest is in its active state.
Returns true if the quest is active, false otherwise (quest not started, inactive or completed)

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

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

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

If parameter "HUNTING" is supplied:
<pre>
0 = Quest not started (not in quest log)
1 = Player hasn't killed all of the target monsters
2 = Player has 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/map/quest.h
</pre>

Find this line and increase the value.
<pre>
#define MAX_QUEST_DB (60355+1) // Highest quest ID + 1
</pre>

Recompile, Cheers!

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

[[Category:Script Command]]

Quest Log System

2014-10-28T00:59:24Z

GmOcean: /* Quest Progress */

== 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 Progress ===

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

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

<pre>*questactive(<ID>)</pre>
Check whether the given quest is in its active state.
Returns true if the quest is active, false otherwise (quest not started, inactive or completed)

=== 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/map/quest.h
</pre>

Find this line and increase the value.
<pre>
#define MAX_QUEST_DB (60355+1) // Highest quest ID + 1
</pre>

Recompile, Cheers!

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

[[Category:Script Command]]