Hercules Wiki - User contributions [en]

Hercules Hierarchy

2015-02-19T01:05:15Z

Sevenzz23: /* Portuguese */

= Staff Titles =
Ordered alphabetically. All staff titles, regardless of their description, possesses full moderation powers.

== Administrators ==
They administrate.
* [http://hercules.ws/board/user/307-haru/ Haru] ([http://hercules.ws/board/index.php?app=members&filter=4 Development Administrator])
* [http://hercules.ws/board/user/1-ind/ Ind] ([http://hercules.ws/board/index.php?app=members&filter=4 Development Administrator])
* [http://hercules.ws/board/user/43-mister-e/ Mister-e] ([http://hercules.ws/board/index.php?app=members&filter=4 Community Administrator])

== Core Developers ==
The kings of the code hill.
* [http://hercules.ws/board/user/20-malufett/ malufett]
* [http://hercules.ws/board/user/49-mkbu95/ mkbu95]
* [http://hercules.ws/board/user/4055-pan/ Pan]
* [http://hercules.ws/board/user/50-michieru/ Michieru]

== Script Developers ==
Usually the members with the fastest key/second typing ratio.
* [http://hercules.ws/board/user/48-dastgir/ Dastgir]
* [http://hercules.ws/board/user/1664-kisuka/ Kisuka]

== Scripting Moderators ==
* [http://hercules.ws/board/user/4102-annieruru/ AnnieRuru]

== Global Moderators ==
Global Moderators are individuals who moderate all of the forums excluding International Communities, however, may still moderate. 
Global Moderator ensure that all of the forums are cleaned by removing duplicate topics, ensuring posts/topics don't have spam, moving topics where need be, and locking topics. 
Global Moderators also provide support to support topics, however, not to an extent as Support Leaders. This is not a position one can apply to, but be promoted to from other moderation position thanks to one's efforts and commitment to moderation.
* [http://hercules.ws/board/user/387-jabote/ jaBote]
* [http://hercules.ws/board/user/83-mumbles/ Mumbles]

== Support Leaders ==
In charge of all the main supporting areas.

== Graphics Moderators ==
In charge of all the main graphics areas.
* [http://hercules.ws/board/user/1460-uzieal/ Uzieal]
* [http://hercules.ws/board/user/11-olrox/ Orlox]

== Int'l Moderators ==
International Moderators are individuals who moderate their respective International Community. 
They are solely responsible in making sure their respective community is cleaned by moving, locking, removing, and cleaning topics of spams. 
International Moderators don't have sole responsibility of other forums outside their community and they must provide support to individuals in their community.

====Filipino====
* [http://hercules.ws/board/user/1582-mhalicot/ Mhalicot]

====Portuguese====
* [http://hercules.ws/board/user/63-juliocf/ JulioCF]
* [http://hercules.ws/board/user/192-wolf/ Wolf]

====Spanish====
* [http://hercules.ws/board/user/125-m45t3r/ M45T3R]

== High Council ==
They're an upgrade from the [[#Community_Contributor | Community Contributor]] title.
* [http://hercules.ws/board/user/59-beret/ Beret]
* [http://hercules.ws/board/user/6674-csnv/ csnv]
* [http://hercules.ws/board/user/6-eiphes/ Eiphes]
* [http://hercules.ws/board/user/8-eurydice/ Eurydice]
* [http://hercules.ws/board/user/1160-gepard/ Gepard]
* [http://hercules.ws/board/user/88-kyeme/ kyeme]
* [http://hercules.ws/board/user/99-muad_dib/ Muad_Dib]
* [http://hercules.ws/board/user/456-rytech/ Rytech]
* [http://hercules.ws/board/user/409-yommy/ Yommy]
* [http://hercules.ws/board/user/67-xgear/ Xgear]

= Former Staff Members =
Former staff members who've contributed throughout Hercules.

== Former Administrators ==
* [http://hercules.ws/board/user/2-jman/ Jman]

== Former Core Developers ==
* [http://hercules.ws/board/user/28-greenbox/ GreenBox]
* [http://hercules.ws/board/user/725-susu/ Susu]

== Former Script Developers ==
* [http://hercules.ws/board/user/756-joseph/ Joseph]
* [http://hercules.ws/board/user/5-kenpachi/ Kenpachi]
* [http://hercules.ws/board/user/23-martin/ Martin]
* [http://hercules.ws/board/user/757-masao/ Masao]
* [http://hercules.ws/board/user/7-nameless2you/ Nameless2you]

== Former Scripting Moderators ==

== Former Global Moderators ==
* [http://hercules.ws/board/user/10-judas/ Judas]

== Former Support Leaders ==
* [http://hercules.ws/board/user/4-emistry/ Emistry]

== Former Graphic Moderators ==
* [http://hercules.ws/board/user/129-adel/ Adel]

== Former International Moderators ==
==== Filipino ====
* [http://hercules.ws/board/user/25-jaypee/ JayPee]

= Community Contributors =
This title is awarded to community members for their outstanding support of Hercules. For more information, [http://hercules.ws/board/topic/376-hercules-cc-program/ read the thread about it on the forum.]
* [http://hercules.ws/board/user/137-bgamez23/ bgamez23]
* [http://hercules.ws/board/user/1352-evilpuncker/ evilpuncker]
* [http://hercules.ws/board/user/5970-gmocean/ GmOcean]
* [http://hercules.ws/board/user/118-mleo1/ mleo1]
* [http://hercules.ws/board/user/315-neo/ Neo]
* [http://hercules.ws/board/user/87-ossi0110/ ossi0110]
* [http://hercules.ws/board/user/449-patskie/ Patskie]
* [http://hercules.ws/board/user/303-ryuuzaki/ Ryuuzaki]
* [http://hercules.ws/board/user/297-shakto/ Shakto]

[[Category:Hercules]]

Hercules Hierarchy

2015-02-19T01:04:47Z

Sevenzz23: /* Script Developers */

= Staff Titles =
Ordered alphabetically. All staff titles, regardless of their description, possesses full moderation powers.

== Administrators ==
They administrate.
* [http://hercules.ws/board/user/307-haru/ Haru] ([http://hercules.ws/board/index.php?app=members&filter=4 Development Administrator])
* [http://hercules.ws/board/user/1-ind/ Ind] ([http://hercules.ws/board/index.php?app=members&filter=4 Development Administrator])
* [http://hercules.ws/board/user/43-mister-e/ Mister-e] ([http://hercules.ws/board/index.php?app=members&filter=4 Community Administrator])

== Core Developers ==
The kings of the code hill.
* [http://hercules.ws/board/user/20-malufett/ malufett]
* [http://hercules.ws/board/user/49-mkbu95/ mkbu95]
* [http://hercules.ws/board/user/4055-pan/ Pan]
* [http://hercules.ws/board/user/50-michieru/ Michieru]

== Script Developers ==
Usually the members with the fastest key/second typing ratio.
* [http://hercules.ws/board/user/48-dastgir/ Dastgir]
* [http://hercules.ws/board/user/1664-kisuka/ Kisuka]

== Scripting Moderators ==
* [http://hercules.ws/board/user/4102-annieruru/ AnnieRuru]

== Global Moderators ==
Global Moderators are individuals who moderate all of the forums excluding International Communities, however, may still moderate. 
Global Moderator ensure that all of the forums are cleaned by removing duplicate topics, ensuring posts/topics don't have spam, moving topics where need be, and locking topics. 
Global Moderators also provide support to support topics, however, not to an extent as Support Leaders. This is not a position one can apply to, but be promoted to from other moderation position thanks to one's efforts and commitment to moderation.
* [http://hercules.ws/board/user/387-jabote/ jaBote]
* [http://hercules.ws/board/user/83-mumbles/ Mumbles]

== Support Leaders ==
In charge of all the main supporting areas.

== Graphics Moderators ==
In charge of all the main graphics areas.
* [http://hercules.ws/board/user/1460-uzieal/ Uzieal]
* [http://hercules.ws/board/user/11-olrox/ Orlox]

== Int'l Moderators ==
International Moderators are individuals who moderate their respective International Community. 
They are solely responsible in making sure their respective community is cleaned by moving, locking, removing, and cleaning topics of spams. 
International Moderators don't have sole responsibility of other forums outside their community and they must provide support to individuals in their community.

====Filipino====
* [http://hercules.ws/board/user/1582-mhalicot/ Mhalicot]

====Portuguese====
* [http://hercules.ws/board/user/63-juliocf/ JulioCF]

====Spanish====
* [http://hercules.ws/board/user/125-m45t3r/ M45T3R]

== High Council ==
They're an upgrade from the [[#Community_Contributor | Community Contributor]] title.
* [http://hercules.ws/board/user/59-beret/ Beret]
* [http://hercules.ws/board/user/6674-csnv/ csnv]
* [http://hercules.ws/board/user/6-eiphes/ Eiphes]
* [http://hercules.ws/board/user/8-eurydice/ Eurydice]
* [http://hercules.ws/board/user/1160-gepard/ Gepard]
* [http://hercules.ws/board/user/88-kyeme/ kyeme]
* [http://hercules.ws/board/user/99-muad_dib/ Muad_Dib]
* [http://hercules.ws/board/user/456-rytech/ Rytech]
* [http://hercules.ws/board/user/409-yommy/ Yommy]
* [http://hercules.ws/board/user/67-xgear/ Xgear]

= Former Staff Members =
Former staff members who've contributed throughout Hercules.

== Former Administrators ==
* [http://hercules.ws/board/user/2-jman/ Jman]

== Former Core Developers ==
* [http://hercules.ws/board/user/28-greenbox/ GreenBox]
* [http://hercules.ws/board/user/725-susu/ Susu]

== Former Script Developers ==
* [http://hercules.ws/board/user/756-joseph/ Joseph]
* [http://hercules.ws/board/user/5-kenpachi/ Kenpachi]
* [http://hercules.ws/board/user/23-martin/ Martin]
* [http://hercules.ws/board/user/757-masao/ Masao]
* [http://hercules.ws/board/user/7-nameless2you/ Nameless2you]

== Former Scripting Moderators ==

== Former Global Moderators ==
* [http://hercules.ws/board/user/10-judas/ Judas]

== Former Support Leaders ==
* [http://hercules.ws/board/user/4-emistry/ Emistry]

== Former Graphic Moderators ==
* [http://hercules.ws/board/user/129-adel/ Adel]

== Former International Moderators ==
==== Filipino ====
* [http://hercules.ws/board/user/25-jaypee/ JayPee]

= Community Contributors =
This title is awarded to community members for their outstanding support of Hercules. For more information, [http://hercules.ws/board/topic/376-hercules-cc-program/ read the thread about it on the forum.]
* [http://hercules.ws/board/user/137-bgamez23/ bgamez23]
* [http://hercules.ws/board/user/1352-evilpuncker/ evilpuncker]
* [http://hercules.ws/board/user/5970-gmocean/ GmOcean]
* [http://hercules.ws/board/user/118-mleo1/ mleo1]
* [http://hercules.ws/board/user/315-neo/ Neo]
* [http://hercules.ws/board/user/87-ossi0110/ ossi0110]
* [http://hercules.ws/board/user/449-patskie/ Patskie]
* [http://hercules.ws/board/user/303-ryuuzaki/ Ryuuzaki]
* [http://hercules.ws/board/user/297-shakto/ Shakto]

[[Category:Hercules]]

Hercules Hierarchy

2015-01-08T08:46:47Z

Sevenzz23:

= Staff Titles =
Ordered alphabetically. All staff titles, regardless of their description, possesses full moderation powers.

== Administrators ==
They administrate.
* [http://hercules.ws/board/user/307-haru/ Haru] ([http://hercules.ws/board/index.php?app=members&filter=4 Development Administrator])
* [http://hercules.ws/board/user/1-ind/ Ind] ([http://hercules.ws/board/index.php?app=members&filter=4 Development Administrator])
* [http://hercules.ws/board/user/43-mister-e/ Mister-e] ([http://hercules.ws/board/index.php?app=members&filter=4 Community Administrator])

== Core Developers ==
The kings of the code hill.
* [http://hercules.ws/board/user/20-malufett/ malufett]
* [http://hercules.ws/board/user/49-mkbu95/ mkbu95]
* [http://hercules.ws/board/user/4055-pan/ Pan]
* [http://hercules.ws/board/user/50-michieru/ Michieru]

== Script Developers ==
Usually the members with the fastest key/second typing ratio.
* [http://hercules.ws/board/user/48-dastgir/ Dastgir]
* [http://hercules.ws/board/user/1664-kisuka/ Kisuka]
* [http://hercules.ws/board/user/192-wolf/ Wolf]

== Scripting Moderators ==
* [http://hercules.ws/board/user/4102-annieruru/ AnnieRuru]

== Global Moderators ==
Global Moderators are individuals who moderate all of the forums excluding International Communities, however, may still moderate. 
Global Moderator ensure that all of the forums are cleaned by removing duplicate topics, ensuring posts/topics don't have spam, moving topics where need be, and locking topics. 
Global Moderators also provide support to support topics, however, not to an extent as Support Leaders. This is not a position one can apply to, but be promoted to from other moderation position thanks to one's efforts and commitment to moderation.
* [http://hercules.ws/board/user/387-jabote/ jaBote]
* [http://hercules.ws/board/user/83-mumbles/ Mumbles]

== Support Leaders ==
In charge of all the main supporting areas.

== Graphics Moderators ==
In charge of all the main graphics areas.
* [http://hercules.ws/board/user/1460-uzieal/ Uzieal]
* [http://hercules.ws/board/user/11-olrox/ Orlox]

== Int'l Moderators ==
International Moderators are individuals who moderate their respective International Community. 
They are solely responsible in making sure their respective community is cleaned by moving, locking, removing, and cleaning topics of spams. 
International Moderators don't have sole responsibility of other forums outside their community and they must provide support to individuals in their community.

====Filipino====
* [http://hercules.ws/board/user/1582-mhalicot/ Mhalicot]

====Portuguese====
* [http://hercules.ws/board/user/63-juliocf/ JulioCF]

====Spanish====
* [http://hercules.ws/board/user/125-m45t3r/ M45T3R]

== High Council ==
They're an upgrade from the [[#Community_Contributor | Community Contributor]] title.
* [http://hercules.ws/board/user/59-beret/ Beret]
* [http://hercules.ws/board/user/6674-csnv/ csnv]
* [http://hercules.ws/board/user/6-eiphes/ Eiphes]
* [http://hercules.ws/board/user/8-eurydice/ Eurydice]
* [http://hercules.ws/board/user/1160-gepard/ Gepard]
* [http://hercules.ws/board/user/88-kyeme/ kyeme]
* [http://hercules.ws/board/user/99-muad_dib/ Muad_Dib]
* [http://hercules.ws/board/user/456-rytech/ Rytech]
* [http://hercules.ws/board/user/409-yommy/ Yommy]
* [http://hercules.ws/board/user/67-xgear/ Xgear]

= Former Staff Members =
Former staff members who've contributed throughout Hercules.

== Former Administrators ==
* [http://hercules.ws/board/user/2-jman/ Jman]

== Former Core Developers ==
* [http://hercules.ws/board/user/28-greenbox/ GreenBox]
* [http://hercules.ws/board/user/725-susu/ Susu]

== Former Script Developers ==
* [http://hercules.ws/board/user/756-joseph/ Joseph]
* [http://hercules.ws/board/user/5-kenpachi/ Kenpachi]
* [http://hercules.ws/board/user/23-martin/ Martin]
* [http://hercules.ws/board/user/757-masao/ Masao]
* [http://hercules.ws/board/user/7-nameless2you/ Nameless2you]

== Former Scripting Moderators ==

== Former Global Moderators ==
* [http://hercules.ws/board/user/10-judas/ Judas]

== Former Support Leaders ==
* [http://hercules.ws/board/user/4-emistry/ Emistry]

== Former Graphic Moderators ==
* [http://hercules.ws/board/user/129-adel/ Adel]

== Former International Moderators ==
==== Filipino ====
* [http://hercules.ws/board/user/25-jaypee/ JayPee]

= Community Contributors =
This title is awarded to community members for their outstanding support of Hercules. For more information, [http://hercules.ws/board/topic/376-hercules-cc-program/ read the thread about it on the forum.]
* [http://hercules.ws/board/user/137-bgamez23/ bgamez23]
* [http://hercules.ws/board/user/1352-evilpuncker/ evilpuncker]
* [http://hercules.ws/board/user/5970-gmocean/ GmOcean]
* [http://hercules.ws/board/user/118-mleo1/ mleo1]
* [http://hercules.ws/board/user/315-neo/ Neo]
* [http://hercules.ws/board/user/87-ossi0110/ ossi0110]
* [http://hercules.ws/board/user/449-patskie/ Patskie]
* [http://hercules.ws/board/user/303-ryuuzaki/ Ryuuzaki]
* [http://hercules.ws/board/user/297-shakto/ Shakto]

[[Category:Hercules]]

Getguildmember

2014-11-11T08:34:58Z

Sevenzz23: Created page with "==Syntax== *getguildmember <guild id>{,<type>}; ==Description== This command will find all members of a specified guild and returns their names (or character id or accou..."

==Syntax==
*[[getguildmember]] <guild id>{,<type>};

==Description==
This command will find all members of a specified guild and returns their names
(or character id or account id depending on the value of "type") into an array
of temporary global variables.

Upon executing this,
<pre>
$@guildmembername$[] is a global temporary string array which contains all the
names of these guild members.
(only set when type is 0 or not specified)

$@guildmembercid[] is a global temporary number array which contains the
character id of these guild members.
(only set when type is 1)

$@guildmemberaid[] is a global temporary number array which contains the
account id of these guild members.
(only set when type is 2)

$@guildmembercount is the number of guild members that were found.
</pre>

The guild members will be found regardless of whether they are online or offline.
Note that the names come in no particular order.

Be sure to use $@guildmembercount to go through this array, and not
'[[getarraysize]]', because it is not cleared between runs of '[[getguildmember]]'.

==Example==
For usage examples, see '[[getpartymember]]'.

==See Also==
*[[getguildmaster]]
*[[getguildmasterid]]
*[[getguildname]]

[[Category:Script Command]]

Donpcevent

2014-11-11T05:10:33Z

Sevenzz23:

==Syntax==
*[[donpcevent]] "<NPC object name>::<event label>";

==Description==
This command invokes the event label code within an another [[NPC]] or NPCs. If ''event label'' has the form "NpcName::OnLabel", then only given NPC's event label will be invoked (much like [[goto]] into another NPC). If the form is "::OnLabel" (''NpcName'' ommited), the event code of all NPCs with given label will be invoked, one after another. In both cases the invoked script will run without an attached [[RID]], whether or not the invoking script was attached to a player. The event label name is required to start with ''On''.

This command can be used to make other NPCs act, as if they were responding to the invoking NPC's actions, such as using an [[emotion]] or [[npctalk|talking]].

==Examples==
prontera,150,150,3 script NPC 53,{
[[mes]] "Hey NPC2 copies what I do.";
[[close2]];
[[set]] .@emote, [[rand]](1,30);
donpcevent "NPC2::OnEmote";
OnEmote:
[[emotion]] .@emote;
[[end]];
}

prontera,152,150,5 script NPC2 53,{
mes "Hey NPC copies what I do.";
close2;
set .@emote, rand(1,30);
donpcevent "NPC::OnEmote";
OnEmote:
emotion .@emote;
end;
}
Whichever of the both NPCs is talked to, both will show a random emotion at the same time.

Command returns 1 or 0 on success and failure. A debug message also shows on the console when no events are triggered.
==See Also==
* [[doevent]]

[[Category:Script Command]]

Save point

2014-11-11T05:05:13Z

Sevenzz23:

==Syntax==
*'''savepoint''' <"map name">, <x>, <y>;

==Description==
This command stores the location, where the [[RID#Usage|invoking character]] will be warped to, when re-spawning after death, getting warped out of a [[WoE]] castle or using skill Teleport Lv2. Map flags, which would otherwise prohibit setting a save point or warping to a map, are ignored by this script command.

==Examples==
[[mes]] "[Kafra Employee]";
mes "Your Respawn Point";
mes "has been saved here";
mes "in the city of Payon.";
mes "Thank you for using";
mes "the Kafra Services.";
savepoint "payon", 257, 242;
[[close2]];
[[cutin]] "", 255;
[[end]];

[[Category:Script Command]]

Save point

2014-11-11T05:04:44Z

Sevenzz23:

==Syntax==
*[[savepoint]] <"map name">, <x>, <y>;

==Description==
This command stores the location, where the [[RID#Usage|invoking character]] will be warped to, when re-spawning after death, getting warped out of a [[WoE]] castle or using skill Teleport Lv2. Map flags, which would otherwise prohibit setting a save point or warping to a map, are ignored by this script command.

==Examples==
[[mes]] "[Kafra Employee]";
mes "Your Respawn Point";
mes "has been saved here";
mes "in the city of Payon.";
mes "Thank you for using";
mes "the Kafra Services.";
savepoint "payon", 257, 242;
[[close2]];
[[cutin]] "", 255;
[[end]];

[[Category:Script Command]]

Max

2014-11-11T05:01:25Z

Sevenzz23: Created page with "== Syntax == *max(<number>{,<number>...<number>}) *min(<number>{,<number>...<number>}) == Description == Returns the smallest (or biggest) from the set of given numbe..."

== Syntax ==
*[[max]](<number>{,<number>...<number>})
*[[min]](<number>{,<number>...<number>})

== Description ==
Returns the smallest (or biggest) from the set of given numbers.

== Example ==
<pre> .@minimum = min(1, -6, -2, 8, 2); // .@minimum will be equal to -6
.@maximum = max(0, 5, 10, 4); // .@maximum will be equal to 10
.@level = min(BaseLevel, 70); // .@level will be the character's base level, capped to 70
</pre>
[[Category:Script Command]]

Min

2014-11-11T05:01:04Z

Sevenzz23: Created page with "== Syntax == *min(<number>{,<number>...<number>}) *max(<number>{,<number>...<number>}) == Description == Returns the smallest (or biggest) from the set of given numbe..."

== Syntax ==
*[[min]](<number>{,<number>...<number>})
*[[max]](<number>{,<number>...<number>})

== Description ==
Returns the smallest (or biggest) from the set of given numbers.

== Example ==
<pre> .@minimum = min(1, -6, -2, 8, 2); // .@minimum will be equal to -6
.@maximum = max(0, 5, 10, 4); // .@maximum will be equal to 10
.@level = min(BaseLevel, 70); // .@level will be the character's base level, capped to 70
</pre>
[[Category:Script Command]]

Setmount

2014-11-11T04:50:23Z

Sevenzz23: Created page with "== Syntax == *setmount {<flag>}; *checkmount() == Description == If <flag> is MOUNT_NONE (or 0) this command will remove the mount from the character. Otherwise i..."

== Syntax ==
*[[setmount]] {<flag>};
*checkmount()
== Description ==
If <flag> is MOUNT_NONE (or 0) this command will remove the mount from the
character. 
 
Otherwise it gives the invoking character the desired combat mount, where
allowed by their class and skills. 
 
If no flag is specified, the mount is automatically chosen according to the
character's class and skills. 
 
The following flag values are accepted:

<pre>
MOUNT_NONE:
- Dismount
MOUNT_PECO:
- PecoPeco (Knight series class)
- GrandPeco (Crusader series class)
- Gryphon (Royal Guard)
MOUNT_WUG:
- Warg (Ranger)
MOUNT_MADO:
- Mado Gear (Mechanic)
MOUNT_DRAGON:
MOUNT_DRAGON_GREEN:
MOUNT_DRAGON_BROWN:
MOUNT_DRAGON_GRAY:
MOUNT_DRAGON_BLUE:
MOUNT_DRAGON_RED:
- Dragon (Rune Knight)
if MOUNT_DRAGON is specified, a the default (green) dragon will be used.
</pre>
Unlike '[[setfalcon]]' and '[[setcart]]' this will not work at all if they aren't of a
class which can ride a mount. 
 
The accompanying function will return 0 if the invoking character is not on a
mount, and a non-zero value (according to the above constants) if they are.
 Note: in case of dragons, the returned value will always be MOUNT_DRAGON,
regardless of color.

== Example ==
<pre>
if (checkmount())
mes "Leave your mount outside! No riding mounts on the floor here!";

if (checkmount() == MOUNT_DRAGON)
mes "Wow, your dragon is cool! Can I pet it?";
</pre>
[[Category:Script Command]]

Quest Log System

2014-11-11T04:37:25Z

Sevenzz23: /* Erase Quest */

== 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-11-11T04:36:09Z

Sevenzz23: /* Complete Quest */

== 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>;</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]]

Getbrokencount

2014-11-11T04:33:45Z

Sevenzz23: Created page with "== Syntax == *getbrokencount() == Description == This function will return the total amount of broken equipment on the invoking character. Category:Script Command"

== Syntax ==
*[[getbrokencount]]()
== Description ==
This function will return the total amount of broken equipment on the
invoking character.

[[Category:Script Command]]

Setcashmount

2014-11-11T04:31:17Z

Sevenzz23: Created page with "== Syntax == *setcashmount; *hascashmount() == Description == The 'setcashmount' function toggles cash mount for the invoking character. It will return 1 if successfu..."

== Syntax ==
*[[setcashmount]];
*hascashmount()

== Description ==
The '[[setcashmount]]' function toggles cash mount for the invoking character.
It will return 1 if successful, 0 otherwise.
 
     Note: Character must not be mounting a non-cash mount (eg. dragon, peco,
wug, etc.) 
 
The accompanying function will return 1 if the invoking character has a
cash mount and 0 if they don't.

[[Category:Script Command]]

Addtimer

2014-06-08T14:23:55Z

Sevenzz23:

[[Category:Script_Command]]
==Syntax==
* [[addtimer]] <ticks>,"NPC::OnEvent";
* [[addtimercount]] "NPC::OnLabel",<ticks>;
* [[deltimer]] "NPC::OnEvent";
==Description==
These commands will create, destroy, and delay a countdown timer - 'addtimer' to
create, 'deltimer' to destroy and 'addtimercount' to delay it by the specified
number of ticks. For all three cases, the event label given is the identifier of
that timer. The timer runs on the character object that is attached to the script (and I'm not sure what happens when nothing is attached), and can have multiple instances. When the label is ran, it is ran as if the player that the timer runs on has clicked the NPC.

When this timer runs out, a new execution thread will start in the specified NPC
object at the specified label. If no such label is found in the NPC object, it
will run as if clicked.

The ticks are given in 1/1000ths of a second.

Setfont

2014-04-11T07:21:59Z

Sevenzz23: Created page with "==Syntax== *setfont ""; ==Description== This command sets the current RO client interface font to one of the fonts stored in data\*.eot by using an ID of the f..."

==Syntax==
*[[setfont]] "";
==Description==
This command sets the current RO client interface font to one of the fonts
stored in data\*.eot by using an ID of the font. When the ID of the
currently used font is used, default interface font is used again.

: 0 - Default 
: 1 - RixLoveangel 
: 2 - RixSquirrel 
: 3 - NHCgogo 
: 4 - RixDiary 
: 5 - RixMiniHeart 
: 6 - RixFreshman 
: 7 - RixKid 
: 8 -: RixMagic 
: 9 - RixJJangu 

==Examples==
Id: 12287
AegisName: "Love_Angel"
Name: "Love Angel Magic Powder"
Type: 11
Buy: 0
Script: <" setfont 1; ">
[[Category:Script Command]]

Hercules Hierarchy

2014-02-12T00:19:52Z

Sevenzz23:

= Staff Titles =
Ordered alphabetically. All staff titles, regardless of their description, possesses full moderation powers.

== Administrators ==
They administrate.
* [http://hercules.ws/board/user/307-haru/ Haru] ([http://hercules.ws/board/index.php?app=members&filter=4 Development Administrator])
* [http://hercules.ws/board/user/1-ind/ Ind] ([http://hercules.ws/board/index.php?app=members&filter=4 Development Administrator])
* [http://hercules.ws/board/user/43-mysterious/ Mysterious] ([http://hercules.ws/board/index.php?app=members&filter=4 Community Administrator])

== Core Developers ==
The kings of the code hill.
* [http://hercules.ws/board/user/20-malufett/ malufett]
* [http://hercules.ws/board/user/49-mkbu95/ mkbu95]
* [http://hercules.ws/board/user/4055-pan/ Pan]

== Script Developers ==
Usually the members with the fastest key/second typing ratio.
* [http://hercules.ws/board/user/1664-kisuka/ Kisuka]
* [http://hercules.ws/board/user/50-michieru/ Michieru]
* [http://hercules.ws/board/user/192-wolf/ Wolf]

== Scripting Moderators ==
* [http://hercules.ws/board/user/4102-annieruru/ AnnieRuru]

== Global Moderators ==
Global Moderators are individuals who moderate all of the forums excluding International Communities, however, may still moderate. 
Global Moderator ensure that all of the forums are cleaned by removing duplicate topics, ensuring posts/topics don't have spam, moving topics where need be, and locking topics. 
Global Moderators also provide support to support topics, however, not to an extent as Support Leaders. This is not a position one can apply to, but be promoted to from other moderation position thanks to one's efforts and commitment to moderation.
* [http://hercules.ws/board/user/387-jabote/ jaBote]
* [http://hercules.ws/board/user/83-mumbles/ Mumbles]

== Support Leaders ==
In charge of all the main supporting areas.

== Graphics Moderators ==
In charge of all the main graphics areas.
* [http://hercules.ws/board/user/1460-uzieal/ Uzieal]
* [http://hercules.ws/board/user/11-olrox/ Orlox]

== Int'l Moderators ==
International Moderators are individuals who moderate their respective International Community. 
They are solely responsible in making sure their respective community is cleaned by moving, locking, removing, and cleaning topics of spams. 
International Moderators don't have sole responsibility of other forums outside their community and they must provide support to individuals in their community.

====Filipino====
* [http://hercules.ws/board/user/1582-mhalicot/ Mhalicot]

====Portuguese====
* [http://hercules.ws/board/user/63-juliocf/ JulioCF]

====Spanish====
* [http://hercules.ws/board/user/125-m45t3r/ M45T3R]

== High Council ==
They're an upgrade from the [[#Community_Contributor | Community Contributor]] title.
* [http://hercules.ws/board/user/59-beret/ Beret]
* [http://hercules.ws/board/user/6-eiphes/ Eiphes]
* [http://hercules.ws/board/user/8-eurydice/ Eurydice]
* [http://hercules.ws/board/user/1160-gepard/ Gepard]
* [http://hercules.ws/board/user/88-kyeme/ kyeme]
* [http://hercules.ws/board/user/99-muad_dib/ Muad_Dib]
* [http://hercules.ws/board/user/456-rytech/ Rytech]
* [http://hercules.ws/board/user/409-yommy/ Yommy]
* [http://hercules.ws/board/user/67-xgear/ Xgear]

= Former Staff Members =
Former staff members who've contributed throughout Hercules.

== Former Administrators ==
* [http://hercules.ws/board/user/2-jman/ Jman]

== Former Core Developers ==
* [http://hercules.ws/board/user/28-greenbox/ GreenBox]
* [http://hercules.ws/board/user/725-susu/ Susu]

== Former Script Developers ==
* [http://hercules.ws/board/user/756-joseph/ Joseph]
* [http://hercules.ws/board/user/5-kenpachi/ Kenpachi]
* [http://hercules.ws/board/user/23-martin/ Martin]
* [http://hercules.ws/board/user/757-masao/ Masao]
* [http://hercules.ws/board/user/7-nameless2you/ Nameless2you]

== Former Scripting Moderators ==

== Former Global Moderators ==
* [http://hercules.ws/board/user/10-judas/ Judas]

== Former Support Leaders ==
* [http://hercules.ws/board/user/4-emistry/ Emistry]

== Former Graphic Moderators ==
* [http://hercules.ws/board/user/129-adel/ Adel]

== Former International Moderators ==
==== Filipino ====
* [http://hercules.ws/board/user/25-jaypee/ JayPee]

= Community Contributors =
This title is awarded to community members for their outstanding support of Hercules. For more information, [http://hercules.ws/board/topic/376-hercules-cc-program/ read the thread about it on the forum.]
* [http://hercules.ws/board/user/48-dastgir-pojee/ Dastgir Pojee]
* [http://hercules.ws/board/user/1352-evilpuncker/ evilpuncker]
* [http://hercules.ws/board/user/118-mleo1/ mleo1]
* [http://hercules.ws/board/user/315-neo/ Neo]
* [http://hercules.ws/board/user/87-ossi0110/ ossi0110]
* [http://hercules.ws/board/user/449-patskie/ Patskie]
* [http://hercules.ws/board/user/303-ryuuzaki/ Ryuuzaki]
* [http://hercules.ws/board/user/297-shakto/ Shakto]

[[Category:Hercules]]

Checkcell

2014-01-29T06:52:57Z

Sevenzz23:

==Syntax==
*[[checkcell]] ("<map name>",<x>,<y>,<type>);
==Description==
This command will return 1 or 0, depending on whether the specified cell
has the '''type''' flag set or not. There are various types to check, all
mimicking the server's cell_chk enumeration. The types can be found in
[https://github.com/HerculesWS/Hercules/blob/master/db/const.txt db/const.txt.]. 
The meaning of the individual types can be confusing, so here's an 
===Overview===
- cell_chkwall/water/cliff
these check directly for the '''terrain component''' of the specified cell
- cell_chkpass/reach/nopass/noreach
passable = not wall & not cliff, reachable = passable
wrt. no-stacking mod
- cell_chknpc/basilica/landprotector/novending/nochat
these check for specific dynamic flags (name indicates what they do)
==Examples==
mes "Pick a destination map.";
input .@map$;
mes "Alright, now give me the coordinates.";
input .@x;
input .@y;
if( !checkcell(.@map$,.@x,.@y,cell_chkpass) )
{
mes "Can't warp you there, sorry!";
close;
}
else
{
mes "Ok, get ready...";
close2;
warp .@map$, .@x, .@y;
end;
}
==See Also==
* [[setcell]]
* [[setwall]]
* [[delwall]]
[[Category:Script Command]]

Setcell

2014-01-29T06:52:48Z

Sevenzz23: /* See Also */

==Syntax==
*[[setcell]] "<map name>",<x1>,<y1>,<x2>,<y2>,<type>,<flag>;
==Description==
Each map cell has several '''flags''' that specify the properties of that cell.
These include terrain properties (walkability, shootability, presence of
water), skills (basilica, land protector, ...) and other (NPC nearby, no
vending, ...).
Each of these can be '''on''' or '''off'''. Together they define a cell's behavior. 
This command lets you alter these flags for all map cells in the specified
(x1,y1)-(x2,y2) rectangle.
'''type''' defines which flag to modify. Possible options include cell_walkable,
cell_shootable, cell_basilica. For a full list, see [https://github.com/HerculesWS/Hercules/blob/master/db/const.txt const.txt.]
'''flag''' can be 0 or 1 (0:clear flag, 1:set flag). 
==Examples==
setcell "arena",0,0,300,300,cell_basilica,1;
setcell "arena",140,140,160,160,cell_basilica,0;
setcell "arena",135,135,165,165,cell_walkable,0;
setcell "arena",140,140,160,160,cell_walkable,1;
This will add a makeshift ring into the center of the map. The ring will
be surrounded by a 5-cell wide '''gap''' to prevent interference from outside,
and the rest of the map will be marked as '''basilica''', preventing observers
from casting any offensive skills or fighting among themselves. Note that
the wall will not be shown nor known client-side, which may cause movement
problems.
==Examples 2==
OnBarricadeDeploy:
setcell "schg_cas05",114,51,125,51,cell_walkable,0;
end;
OnBarricadeBreak:
setcell "schg_cas05",114,51,125,51,cell_walkable,1;
end;
This could be a part of the WoE:SE script, where attackers are not allowed
to proceed until all barricades are destroyed. This script would place and
remove a nonwalkable row of cells after the barricade mobs.
==See Also==
* [[checkcell]]
* [[setwall]]
* [[delwall]]
[[Category:Script Command]]

Setcell

2014-01-29T06:51:49Z

Sevenzz23:

==Syntax==
*[[setcell]] "<map name>",<x1>,<y1>,<x2>,<y2>,<type>,<flag>;
==Description==
Each map cell has several '''flags''' that specify the properties of that cell.
These include terrain properties (walkability, shootability, presence of
water), skills (basilica, land protector, ...) and other (NPC nearby, no
vending, ...).
Each of these can be '''on''' or '''off'''. Together they define a cell's behavior. 
This command lets you alter these flags for all map cells in the specified
(x1,y1)-(x2,y2) rectangle.
'''type''' defines which flag to modify. Possible options include cell_walkable,
cell_shootable, cell_basilica. For a full list, see [https://github.com/HerculesWS/Hercules/blob/master/db/const.txt const.txt.]
'''flag''' can be 0 or 1 (0:clear flag, 1:set flag). 
==Examples==
setcell "arena",0,0,300,300,cell_basilica,1;
setcell "arena",140,140,160,160,cell_basilica,0;
setcell "arena",135,135,165,165,cell_walkable,0;
setcell "arena",140,140,160,160,cell_walkable,1;
This will add a makeshift ring into the center of the map. The ring will
be surrounded by a 5-cell wide '''gap''' to prevent interference from outside,
and the rest of the map will be marked as '''basilica''', preventing observers
from casting any offensive skills or fighting among themselves. Note that
the wall will not be shown nor known client-side, which may cause movement
problems.
==Examples 2==
OnBarricadeDeploy:
setcell "schg_cas05",114,51,125,51,cell_walkable,0;
end;
OnBarricadeBreak:
setcell "schg_cas05",114,51,125,51,cell_walkable,1;
end;
This could be a part of the WoE:SE script, where attackers are not allowed
to proceed until all barricades are destroyed. This script would place and
remove a nonwalkable row of cells after the barricade mobs.
==See Also==
* [[checkwall]]
* [[setwall]]
* [[delwall]]
[[Category:Script Command]]

Checkcell

2014-01-29T06:51:42Z

Sevenzz23: Created page with "==Syntax== *checkwall ("<map name>",<x>,<y>,<type>); ==Description== This command will return 1 or 0, depending on whether the specified cell has the '''type''' flag s..."

==Syntax==
*[[checkwall]] ("<map name>",<x>,<y>,<type>);
==Description==
This command will return 1 or 0, depending on whether the specified cell
has the '''type''' flag set or not. There are various types to check, all
mimicking the server's cell_chk enumeration. The types can be found in
[https://github.com/HerculesWS/Hercules/blob/master/db/const.txt db/const.txt.]. 
The meaning of the individual types can be confusing, so here's an 
===Overview===
- cell_chkwall/water/cliff
these check directly for the '''terrain component''' of the specified cell
- cell_chkpass/reach/nopass/noreach
passable = not wall & not cliff, reachable = passable
wrt. no-stacking mod
- cell_chknpc/basilica/landprotector/novending/nochat
these check for specific dynamic flags (name indicates what they do)
==Examples==
mes "Pick a destination map.";
input .@map$;
mes "Alright, now give me the coordinates.";
input .@x;
input .@y;
if( !checkcell(.@map$,.@x,.@y,cell_chkpass) )
{
mes "Can't warp you there, sorry!";
close;
}
else
{
mes "Ok, get ready...";
close2;
warp .@map$, .@x, .@y;
end;
}
==See Also==
* [[setcell]]
* [[setwall]]
* [[delwall]]
[[Category:Script Command]]

Setcell

2014-01-29T06:40:51Z

Sevenzz23: Created page with "==Syntax== *'''setcell''' "<map name>",<x1>,<y1>,<x2>,<y2>,<type>,<flag>; ==Description== Each map cell has several '''flags''' that specify the properties of that cell. Th..."

==Syntax==
*'''setcell''' "<map name>",<x1>,<y1>,<x2>,<y2>,<type>,<flag>;
==Description==
Each map cell has several '''flags''' that specify the properties of that cell.
These include terrain properties (walkability, shootability, presence of
water), skills (basilica, land protector, ...) and other (NPC nearby, no
vending, ...).
Each of these can be '''on''' or '''off'''. Together they define a cell's behavior. 
This command lets you alter these flags for all map cells in the specified
(x1,y1)-(x2,y2) rectangle.
'''type''' defines which flag to modify. Possible options include cell_walkable,
cell_shootable, cell_basilica. For a full list, see [https://github.com/HerculesWS/Hercules/blob/master/db/const.txt const.txt.]
'''flag''' can be 0 or 1 (0:clear flag, 1:set flag). 
==Examples==
setcell "arena",0,0,300,300,cell_basilica,1;
setcell "arena",140,140,160,160,cell_basilica,0;
setcell "arena",135,135,165,165,cell_walkable,0;
setcell "arena",140,140,160,160,cell_walkable,1;
This will add a makeshift ring into the center of the map. The ring will
be surrounded by a 5-cell wide '''gap''' to prevent interference from outside,
and the rest of the map will be marked as '''basilica''', preventing observers
from casting any offensive skills or fighting among themselves. Note that
the wall will not be shown nor known client-side, which may cause movement
problems.
==Examples 2==
OnBarricadeDeploy:
setcell "schg_cas05",114,51,125,51,cell_walkable,0;
end;
OnBarricadeBreak:
setcell "schg_cas05",114,51,125,51,cell_walkable,1;
end;
This could be a part of the WoE:SE script, where attackers are not allowed
to proceed until all barricades are destroyed. This script would place and
remove a nonwalkable row of cells after the barricade mobs.
==See Also==
* [[setwall]]
* [[delwall]]
[[Category:Script Command]]

Getmobdrops

2014-01-20T14:08:00Z

Sevenzz23: Created page with "== Syntax == * getmobdrops (<mob id>); == Description == This command will find all drops of the specified mob and return the item IDs and drop percentages into array..."

== Syntax ==
* [[getmobdrops]] (<mob id>);

== Description ==
This command will find all drops of the specified mob and return the item
IDs and drop percentages into arrays of temporary global variables.
'getmobdrops' returns 1 if successful and 0 if the mob ID doesn't exist.

Upon executing this,

{| class="wikitable" border="1"
!Array
!Description
|-
| '''$@MobDrop_item[]''' || is a global temporary number array which contains the item IDs of the monster's drops.
|-
| '''$@MobDrop_rate[]''' || is a global temporary number array which contains the drop percentages of each item. (1 = .01%)
|-
| '''$@MobDrop_count''' || is the number of item drops found.
|}

Be sure to use '''$@MobDrop_count''' to go through the arrays, and not [[getarraysize]], because the temporary global arrays are not cleared between runs of [[getmobdrops]]. If a mob with 7 item drops is looked up,
the arrays would have 7 elements. But if another mob is looked up and it only has 5 item drops, the server will not clear the arrays for you, overwriting the values instead. So in addition to returning the 5 item drops, the 6th and 7th elements from the last call remain, and you will get 5+2 item drops, of which the last 2 don't belong to the new mob.
'''$@MobDrop_count''' will always contain the correct number (5), unlike
[[getarraysize]] which would return 7 in this case.

== Examples ==

// get a Mob ID from the user
input .@mob_id;

if (getmobdrops(.@mob_id)) { // 'getmobdrops' returns 1 on success
// immediately copy global temporary variables into scope
// variables, since we don't know when 'getmobdrops' will get
// called again for another mob, overwriting your global temporary
// variables.
set .@count, $@MobDrop_count;
copyarray .@item[0],$@MobDrop_item[0],.@count;
copyarray .@rate[0],$@MobDrop_rate[0],.@count;

mes getmonsterinfo(.@mob_id,MOB_NAME) + " - " + .@count + " drops found:";
for( set .@i,0; .@i < .@count; set .@i,.@i +1 ) {
mes .@item[.@i] + " (" + getitemname(.@item[.@i]) + ") "
+ .@rate[.@i]/100 + ((.@rate[.@i]%100 < 10) ? ".0":".") + .@rate[.@i]%100 + "%";
}
} else {
mes "Unknown monster ID.";
}
close;

[[Category:Script Command]]

Delmonsterdrop

2014-01-20T13:45:22Z

Sevenzz23: Created page with "== Syntax == * delmonsterdrop (<mob id or name>, <item id>); == Description == This command will temporarily remove a drop from an existing monster. Both the mo..."

== Syntax ==
* [[delmonsterdrop]] (<mob id or name>, <item id>);
== Description ==
This command will temporarily remove a drop from an existing monster.

Both the monster and the item must be valid.

Return value will be 1 in case of success (the item was removed), and 0 
otherwise (the monster didn't have the specified item in its drop list).
== Example ==
// Remove Jellopy (909) from the Poring's (1002) drops
delmonsterdrop(1002, 909);
== See Also ==
* [[addmonsterdrop]]

[[Category:Script Command]]

Addmonsterdrop

2014-01-20T13:35:42Z

Sevenzz23: Created page with "== Syntax == * addmonsterdrop (<mob id or name>, <item id>, <rate>); == Description == This command will temporarily add a drop to an existing monster. If the monst..."

== Syntax ==
* [[addmonsterdrop]] (<mob id or name>, <item id>, <rate>);
== Description ==
This command will temporarily add a drop to an existing monster. If the 
monster already drops the specified item, its drop rate will be updated to the 
given value.

Both the monster and the item must be valid. Acceptable values for the drop 
rate are in the range [1:10000].

Return value will be 1 in case of success (the item was added or its drop rate 
was updated), and 0 otherwise (there were no free item drop slots).
== Example ==
// Add Poring Doll (741) to the Poring's (1002) drops, with 1% (100) rate
addmonsterdrop(1002, 741, 100);
== See Also ==
* [[delmonsterdrop]]

[[Category:Script Command]]

Server Modification

2014-01-04T12:32:56Z

Sevenzz23: /* Source Modifications */

You can find here some information to start making server-side source modifications.

== How Hercules works ==
Hercules has a multi-process architecture. It runs three different processes: '''login-server''', '''char-server''' and '''map-server'''.

=== Login Server ===
'''Login server''' ''':''' receives the login packet, checks if account exists and if the password is correct. If all is OK, the connection is then passed to the '''char-server'''.

=== Char-Server ===

'''Char-server''' ''':''' controls all the character related, Guild, party, pet, inventory etc.

=== Map-Server ===
The last one is the '''map-server''', which controls char and NPC position, chats, skills, exp etc.

== Source Modifications ==
Before you start modifying [[Hercules]], you should better take a look first on [[:Category:Source_Functions]].
Remember, it's necessary to [[Compiling|re-compile]] [[Hercules]] after a source modification.
You can also find information about [[packets]].

=== Pre-Made Modifications ===
Also can take a look at modifications made by other users.
* [[:Category:Source Snippets|Source Snippets]]
* [[Customizing Sheet]]

[[Category:Customization]]

Custom Pets

2013-12-27T05:53:30Z

Sevenzz23:

==The Pet DB==
The information about pets are stored in the pet_db.txt file in the db folder. Here is a quick
rundown of what the database contains. We will look at a Poring, as an example.
<pre>
MobID,Name,JName,ItemID,EggID,AcceID,FoodID,
Fullness,HungryDelay,R_Hungry,,R_Full,Intimate,Die,
Capture,Speed,S_Performance,talk_convert_class,
attack_rate,defence_attack_rate,change_target_rate, pet_script
</pre> 
<pre>
1002,PORING,Poring,619,9001,10013,531,80,20,50,100,250,20,2000,400,1,0,350,400,800,{ petloot 10; }
</pre> 
* '''MobID:''' Obvious, check mob_db.txt for a monster's MobID.
* '''Name:''' Again, check mob_db.txt for this value. It is the second value in mob_db.
* '''JName:''' Basically will be the default name for your pet.
* '''ItemID:''' The taming item's ID. In this case, an Unripe Apple(619).
* '''EggID:''' The egg's ID.
* '''AcceID:''' The item ID of the accessory. '''For custom pets, leave this value to be 0.'''
* '''FoodID:''' The food for your pet. In this case, Apple Juice(531).
* '''Fullness:''' No idea, but every pet seems to have a value of 80. Keep it at that.
* '''HungryDelay:''' The rate the pet gets hungry. The lower the number, the faster it will get hungry.
* '''R_Hungry:''' No idea. I made the value for mine 20.
* '''R_Full:''' No idea. I made the value for mine 100.
* '''Intimate:''' No idea. I made the value for mine 250.
* '''Die:''' How much intimacy points you lose when you die. Usually set to 20.
* '''Capture:''' The rate of capture. 1% = 100 and 100% = 10000. Basically, choose your percentage and add two zeroes to the end.
* '''Speed:''' The speed in which the pet will follow you (not sure). I set mine at 200.
* '''S_Performance:''' No idea. I set mine at 1.
* '''talk_convert_class:''' The pet's dialogue used in pettalktable. This will allow your custom pets to talk like certain pets.
* '''attack_rate:''' Chance the pet will attack. Same format as Capture rate.
* '''defence_rate:''' Chance the pet will attack when master is attacked. Same format as Capture rate.
* '''change_target_rate:''' Chance the pet will change targets. Same format as Capture rate.
* '''pet_script:''' The special skill used by the pet. 
As to pet skills, pet_db gives an in depth explanation on how to use it. It's quite simple to
give your custom pet custom skills, so I will not be detailing this in this guide. If you want
your custom pets to use skills, you may have to change:
<pre>
// Does the pet need its equipment before it does its skill? (Note 1)
pet_equip_required: yes
</pre>
to no, since they will not have equipment

==The Item DB==
Taming items and pet egg information are stored in the item_db.conf file. A taming item format
is the following, using an Unripe Apple(619) as an example:
<pre>
{
Id: 619
AegisName: "Unripe_Apple"
Name: "Unripe Apple"
Type: 2
Buy: 1000
Weight: 50
Upper: 63
Script: <" pet 1002; ">
},
</pre>
Important to note is the part in bold. The ETC item you use for custom taming items will need
to follow this same format. 
A pet egg format is the following, using a Poring Egg(9001) as an example:
<pre>
{
Id: 9001
AegisName: "Poring_Egg"
Name: "Poring Egg"
Type: 7
Buy: 20
},
</pre>
This part is very easy, as you can see. 
Basically, model your taming items and eggs to these formats, and you will not need to know any specifics.

==Replacing A Pet==
The easiest way to have a custom pet is to replace a current pet. Say you want a Succubus
(1370). Choose a pet that you don't want anymore. For our example, we will replace a Poring. To do this, simply replace the following to get a custom pet that has the exact same status and skills as a Poring.
<pre>
1370,SUCCUBUS,Succubus,619,9001,0,531,80,20,50,100,250,20,2000,400,1,0,350,400,800,{ petloot 10; }
</pre>
You can customize this further by editing the values you wish. Notice that the accessory value has been changed to 0. 
Next, you must inherit the item in item_db2.conf for information about the taming item. To do this, Add the following values, following the format of the Item DB explained above:
<pre>
{
Id: 619
Inherit: true
Script: <" pet 1370; ">
},
</pre>
''Note: Read more information about [http://hercules.ws/board/topic/2954-item-db-file-structure-overhaul/ Item DB file structure overhaul]'' 
Now you are done, and have a Succubus instead of a Poring. To catch a Succubus, you will use an Unripe Apple (619). To change the item descriptions and egg sprites, please refer to another section of this guide.

==Adding A New Pet==
I didn't like the idea of replacing an existing pet, so I sought to add in pets. The process is
a little similar to replacing a pet. Instead, you create a new line in pet_db.txt with your
new pet information. As an example, we will add a Succubus to the pet_db.
<pre>
1370,SUCCUBUS,Succubus,739,9031,0,537,80,20,20,100,250,20,150,200,1,0,800,400,200,
{ petskillbonus bLuk,20,10,90; }
</pre>
I made the Succubus's taming item a Rouge(739), her food Pet Food(537), her capture rate 1.5%, and her pet skill +20 Luck for 10 seconds every 90 seconds. 
Add the above line to the end of pet_db, and you are done. Now we have all the original pets AND a Succubus. 
The next step is to create a taming item and an egg for this Succubus. To create the taming
item, go to item_db, and pick an item you want to use for the taming item and add Inherit it on item_db2. I suggest using an ETC item, as they really do not serve much purpose. Edit the values accordingly to follow the pet taming item format. An example of Rouge for the Succubus taming item:
<pre>
{
Id: 739
Inherit: true
Type: 2
Upper: 63
Script: <" pet 1370; ">
},
</pre>
Next, we need a pet egg. This, you will have to actually create. Choose an available Item ID. I
suggest starting from 9028, if not already used, and work your way up, for pet eggs. Add a line to item_db2.conf with the values for a pet egg. For example, a Succubus egg:
<pre>
{
Id: 9031
AegisName: "Succubus_Egg"
Name: "Succubus Egg"
Type: 7
Buy: 20
},
</pre>
The egg ID is 9031, as you can also see from the entry in pet_db. 
After doing this, you now have added a Succubus into the database, with her own taming item and egg. Everything is now ready on the server side.

==Egg Sprites and Item Descriptions==
In order for your client to not crash, you must have information and a sprite for the pet egg.
For old client. Go to your idnum2itemdesctable.txt, idnum2itemdisplaynametable.txt, num2itemdesctable.txt, and num2itemdisplaynametable.txt, and create a new entry for the egg. I will not go into detail on how to do this; there are other guides for this. You may also choose to edit the item
description of the taming item, though this is not necessary. 
Next, you have to give the egg a sprite, or else your client will crash. To do this, edit
idnum2itemresnametable.txt and num2itemresnametable.txt and add in an entry for the egg. Refer to this topic for what to use for egg sprites. If you have no clue how to work with resnametables, then search the forums. 
I will give examples of the values I put in my tables. 
idnum2itemdesctable and num2itemdesctable:
<pre>
9031#
An egg in which a Succubus Cute Pet rests. Can be hatched by using a ^33CC33Pet Incubator^000000.
Class :^777777 Monster Egg^000000
#
</pre>
idnum2itemdisplaynametable and num2itemdisplaynametable:
<pre>
9031#Succubus_Egg#
</pre>

idnum2itemresnametable and num2itemresnametable:
<pre>
9031#Áö¼Ó¼º¾Ë#
</pre>
If you use 2013 client, edit your iteminfo.lua\lub. Visit [[Custom_Items#Item_Placement_on_Data_Folder_.28For_New_Clients.29|Item Placement on Data Folder]] 
<pre>
[9031] = {
unidentifiedDisplayName = "Succubus Egg",
unidentifiedResourceName = "¾Ï¼Ó¼º¾Ë",
unidentifiedDescriptionName = {
"An egg in which a",
"Succubus Cute Pet rests.",
"Can be hatched by",
"using a ^33CC33Pet Incubator^000000.",
"^33CC33Cordial/Loyal Bonus^000000",
"When summoned,",
"Has a chance of draining 2% of enemy's HP while attacking.",
"Class: ^777777Monster Egg^000000"
},
identifiedDisplayName = "Succubus Egg",
identifiedResourceName = "¾Ï¼Ó¼º¾Ë",
identifiedDescriptionName = {
"An egg in which a",
"Succubus Cute Pet rests.",
"Can be hatched by",
"using a ^33CC33Pet Incubator^000000.",
"^33CC33Cordial/Loyal Bonus^000000",
"When summoned,",
"while physically attacking, physical damage done to enemy, 5% will transfer as your HP",
"Class: ^777777Monster Egg^000000"
},
slotCount = 0,
ClassNum = 0
},
</pre>

==Pettalktable==
By default, your pet will talk like a Poring. If you wish to change this, edit the
talk_convert_class value in pet_db to the ID of one of the original pets. For example, to make our Succubus talk like a Zealotus, edit her talk_convert_class to 1200. Now she will talk like a Zealotus. 
If you want to edit what she says, then you may. However, note that if you edit this, both the
Zealotus and Succubus will say the same things. It is not currently possibly to add in talk
for Succubus and not replace anything. I recommend choosing a pet that you or your clients may never use, and replace that pet's dialogue.

==Q&A==
Q. What will the pet portrait be? 
A. The pet portrait will be a Poring by default. Customised images should be placed in:
:data\texture\À¯ÀúÀÎÅÍÆäÀÌ½º\illust 
 
Q. What will the new pet's performance be? 
A. Nothing. The sprite will disappear and reappear quickly. Your game won't crash. 
 
Q. How many pets can I add? 
A. Up to 300. I believe that if you change the MAX_PET_DB value in pet.h in the src/map folder, you can add more. Note that you will have to recompile. 
 
Q. Why does the egg name become red when I try to hatch it and the pet not show up? 
A. This is caused by the egg being spawned via an @item command (or equivalent). To create the egg you need to use the @makeegg command. 
 

[[Category:Customization]]
[[Category:Data]]
[[Category:Database]]

Adding new statuses

2013-12-25T12:06:54Z

Sevenzz23:

== Information ==

When modifying your server, the time may come when you need to add or ammend status effects, and the bonuses or the 'scripts' that they provide. To do so, will require some source modifications, but will result in the ability to create and initialize status effects.

== Open {{git|src/map/status.h}} ==

You will notice a large enumerator called "sc_type", which defines the different statuses. When creating a new status, we need to move to the ''end'' of the enumerator, and add a custom SC type like below:

<pre> SC_HELLPOWER = 294,
SC_INVINCIBLE, //295
SC_INVINCIBLEOFF,
SC_CUSTOMSTATUS, // This is our custom status effect

SC_MAX, //Automatically updated max, used in for's to check we are within bounds.</pre>

Note that SC_CUSTOMSTATUS is placed ''before'' the SC_MAX entry. Any new status effects must be placed before SC_MAX and preceed with a comma. Here we have declared a new status effect, so we can now move onto use it.

== Open {{git|src/map/status.c}} ==

Jump to the function ''status_change_start'':

=== Status effect immunity ===

<pre> undead_flag = battle->check_undead(status->race,status->def_ele);
//Check for inmunities / sc fails
switch (type)
{</pre>

This block is where we actually perform any checks, such as circumstances which disallow a status from being used.
For example, let's say that SC_CUSTOMSTATUS cannot be inflicted when the target has SC_BLIND active.

<pre> case SC_CUSTOMSTATUS:
if(sc->data[SC_BLIND])
return 0;
break;</pre>

And now, if the target has SC_BLIND active, the status will not be inflicted at all.

=== Status effect curing ===

<pre> //Before overlapping fail, one must check for status cured.
switch (type)
{</pre>

This block actually cancels ''other'' status effects if your status effect is being activated. Like the above, it's not necessary, but let's say that SC_CUSTOMSTATUS ''removes'' SC_BLIND.

<pre> case SC_CUSTOMSTATUS:
status_change_end(bl, SC_BLIND, -1);
break;</pre>

As simple as that, now whenever SC_CUSTOMSTATUS is inflicted, SC_BLIND will be removed.

=== val1, val2, val3 and val4 ===

<pre> case SC_REBIRTH:
val2 = 20*val1; //% of life to be revived with
break;</pre>

If you find this piece of code, it means you're in the actual block which manipulates val1, val2, val3, val4 and tick. This is especially useful when altering status effects that have been initialized by skills.

<pre> case SC_CUSTOMSTATUS:
val2 = val1 * 30; // HIT reduced by 30 per val1.
break;</pre>

In this block of code, we set the 'val2' property of SC_CUSTOMSTATUS to ''val1 * 30''. Therefore, if val1 is set to 1, val2 is 30, is val1 is set to 2, val2 is 60. Usually, skills pass '''skill_lv''' (the level of the skill used) into val1, which means you can adjust the settings for val2, val3 and val4 based on the skill level used.

=== Using the status effect ===

Jump to the function ''status_calc_hit'':

<pre> if(sc->data[SC_MERC_HIT])
hit += sc->data[SC_MERC_HIT]->val2;</pre>

As you can see, SC_MERC_HIT directly influences the HIT rate as calculated in ''status_calc_hit''. We can add a custom code which will also modify HIT, such as below:

<pre> if(sc->data[SC_CUSTOMSTATUS])
hit -= sc->data[SC_CUSTOMSTATUS]->val2;</pre>

This means that HIT will be decreased by whatever value is in val2 (as calculated in ''status_change_start'').

== Open {{git|db/const.txt}} ==

=== Implementing ===

Find
<pre>SC_INVINCIBLEOFF<tab>296</pre>

Add below
<pre>SC_CUSTOMSTATUS<tab>297</pre>

And there you go. The status effect ''SC_CUSTOMSTATUS'' is now ready for use.

=== Using the status ===

<pre>sc_start SC_CUSTOMSTATUS, 60000, 2;</pre>

This will start SC_CUSTOMSTATUS, it will last for 60 seconds and it will remove SC_BLIND if it is active.
The '2' is the ''val1'' entry, which means that ''val2 = 2 * 30;'', which will cause HIT to be decreased by 60 for 60 seconds.

[[Category:Source Snippets]]
[[Category:Customization]]

Adding new skills

2013-12-25T11:31:26Z

Sevenzz23:

== Introduction ==

A large area where players have difficulty is adding new skills to the source and client. To implement new skills, it's required that you use an XRay client (if you don't want to use XRay, you will have to replace existing, un-used skills and edit their previous descriptions).

Below will be documentation on how to implement these new skills

== The skill ==

The skill I will be working on is a simple one.

<pre>Earth Bolt
Max Level: 10
Type: Active
SP Cost: 20 + 5*SkillLV
Target: 1 Enemy
Cast Time: 2 sec
Cool Down: 1 sec
Duration: Instant
Deals SkillLV bolts of Earth magic damage to one enemy, at 150% MATK per hit.</pre>

Basically, this skill should target 1 enemy, and deal 10 hits of 150% MATK, Earth elemental property and should be magic damage based.

== Open /src/map/skill.h ==

Scroll down until you find
<pre> EL_STONE_HAMMER,
EL_ROCK_CRUSHER,
EL_ROCK_CRUSHER_ATK,
EL_STONE_RAIN,</pre>

After here is where we add any additional skills. It's better to give the skills a custom ID to begin with. So, let's add our "Earth Bolt" skill.

After those, add
<pre> MG_EARTHBOLT = 8443,</pre>

MG_ definitively means "Mage", you'll work out the acronyms as you scroll through the skills.
We have defined the basis of the skill. As you can see, the skill id is set to '8443' since Earth Elemental's Stone Rain is set to 8442 (and is the last player accessible skill).

== Open /src/map/skill.c ==

This file is where we define the actual skill implementations. For single-target skills, all processing of that skill will go in ''skill_castend_damage_id'' (for damaging skills) or ''skill_castend_nodamage_id'' (for non-damage skills).

=== Magic based skills ===

Because Earth Bolt is '''damage''' based, find the ''skill_castend_damage_id'' function and find:

<pre> case AB_RENOVATIO:
case AB_HIGHNESSHEAL:
case AB_DUPLELIGHT_MAGIC:
case WM_METALICSOUND:
case MH_ERASER_CUTTER:</pre>

The reason we will be placing the ''case'' for Earth Bolt here is because:

<pre> skill->attack(BF_MAGIC,src,src,bl,skill_id,skill_lv,tick,flag);</pre>

The BF_MAGIC quality means that the skill is magic based, and should be calculated under the magic battle calculations.
So, after <code>case NJ_HUUJIN</code> add:

<pre> case MG_EARTHBOLT:</pre>

=== Weapon based skills ===

In the event of wanting to add a skill that's based on Weapon, rather than Magic, find:

<pre> case WM_GREAT_ECHO:
case GN_SLINGITEM_RANGEMELEEATK:
case KO_JYUMONJIKIRI:
case KO_SETSUDAN:
case KO_KAIHOU:</pre>

And add the case after those.
If we wanted Earth Bolt to be weapon based, it would look like this:

<pre> case WM_GREAT_ECHO:
case GN_SLINGITEM_RANGEMELEEATK:
case KO_JYUMONJIKIRI:
case KO_SETSUDAN:
case KO_KAIHOU:
case MG_EARTHBOLT:</pre>

However, we will stick to the Magic function instead.

== Open /src/map/battle.c ==

In this function, all main damage calculations are performed. And in seperate functions, the % modifiers for the skills are stored. Therefore, for our 150% damage, we add the extra 50% (since 100% is the default) in the appropriate function.

=== Weapon based attacks ===

For '''Weapon''' based attacks, the modifiers are found in ''battle_calc_weapon_attack''.
Simply find:

<pre> case NPC_VAMPIRE_GIFT:
skillratio += ((skill_lv-1)%5+1)*100;
break;</pre>

And add your damage modifier there.
For example, if Earth Bolt was Weapon based, we would add:

<pre> case MG_EARTHBOLT:
skillratio += 50;
break;</pre>

The ''+= 50'' simply means "Add 50% onto the 100%" for 150% ATK damage.

=== Magic based attacks ===

For '''Magic''' based attacks, the modifiers are found in ''battle_calc_magic_attack''.
Simply find:

<pre> case NPC_EARTHQUAKE:
skillratio += 100 +100*skill_lv +100*(skill_lv/2);
break;</pre>

And add the damage modifier below. Since Earth Bolt is magic based, we add it here.

<pre> case MG_EARTHBOLT:
skillratio += 50;
break;</pre>

This now means that Earth Bolt will deal Magic damage at 150% MATK.

== Skill database support ==

Technically speaking, the basis of the skill is now in place. Of course, if you want to implement more complex skills, there's a lot more to it. A seperate section will be created in the future for this. But for now, we need to implement the skill database entries.
The files below can be find within db/(pre/re)/.
Only one from both (pre/re) need to be updated, it's one you use in your server.

=== skill_db.txt ===

For our Earth Bolt, we can now enter this:

<pre>8443,5,8,1,2,0,0,10,1:2:3:4:5:6:7:8:9:10,yes,0,0,0,magic,0,MG_EARTHBOLT,Earth Bolt</pre>

This defines that:

<code>Earth Bolt has a range of 5 cells, hits multiple times, is Earth element and targets 1 enemy. It can be interrupted, and is of magic type damage. The amount of hits increases by 1 every level, with a maximum level of 10.</code>

=== skill_cast_db.txt ===

For our Earth Bolt, we can now enter this:

<pre>8443,2000,1000,0,0,0</pre>

This defines that:

<code>Earth Bolt has a 2 second cast time, and a 1 second delay time. There is no after-cast walk-delay</code>

=== skill_require_db.txt ===

For our Earth Bolt, we can now enter this:

<pre>8443,0,0,25:30:35:40:45:50:55:60:65:70,0,0,0,99,0,0,none,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0</pre>

This defines that:

<code>Earth Bolt requires 25 SP at level 1, 30 SP at level 2 .. 70 SP at level 10. Can be cast with any weapon, doesn't require a state and doesn't require any items to be consumed.</code>

=== skill_tree.txt ===

This part of the database isn't necessary if it can't be learned by a class. However, if you want a class to learn a skill, you have to make an entry in skill_tree.txt. An example below:

<pre>MG_EARTHBOLT: {
MaxLevel: 10
MG_FIREBOLT: 5
MG_LIGHTNINGBOLT: 5
}</pre>

This defines that:

<code>Earth Bolt can be learned by Mage, has a maximum level of 10 (for this class), and requires skill MG_FIREBOLT at level 5, and skill MG_LIGHTNINGBOLT at level 5.</code>

----

Technically, this is usually all the areas that you'd usually cover with skill database files. There are more, but that's for you to explore.

== XRay support ==

To support the skill in the actual client, assuming you're using XRay (required to add new IDs for skills), you can do the following:

=== ability_tab.txt ===

To add in the custom skill, find:

<pre>NJ_ISSEN</pre>

And below it, add:

<pre>MG_EARTHBOLT</pre>

=== leveluseskillspamount.txt ===

To make the skill level-selectable, simply add an entry in leveluseskillspamount.txt in the data folder.

<pre>8443#
25#
30#
35#
40#
45#
50#
55#
60#
65#
70#
@</pre>

This will allow the skill to be level selectable.

== Renewal/Non-Xray Support ==
The following implementations are according to Revision 228 from Lua Project(2012-05-23)+.
To support Renewal and post 10/13/2009 Clients (or the last Xray) we'd need to make use of .[[lua]] and .[[lub]] files.

The implementation is different between then many client versions, but there's generally 2 implementations:
=== no skillinfoz folder ===

in data/lua files/skillinfo/skilltreeview.lua find:
<pre>
{"MG_FIREWALL", 18; Pos = 19, MaxLv = 10, NeedSkillList = {6, 12}}
</pre>
change to:
<pre>
{"MG_FIREWALL", 18; Pos = 19, MaxLv = 10, NeedSkillList = {6, 12}},
{"MG_EARTHBOLT",8443; Pos = 20, MaxLv = 10, NeedSkillList = {19,20}}
</pre>

=== has skillinfoz folder ===
skillid.lua find:
<pre>
ECLAGE_RECALL = 3035,
</pre>
After Add:
<pre>
MG_EARTHBOLT = 8443,
</pre>

in data/lua files/skillinfo/skilldescript.lua find:
<pre>
[SKID.MG_THUNDERSTORM] = {

"Thunder Storm",
"Max Level:^777777 10 ^000000",
"Type:^777777 Offensive ^000000",
"SP Cost:^777777 24 + 5*SkillLV ^000000",
"Target:^777777 cell ^000000",
"Range:^777777 9 cells ^000000",
"Cast Time:^777777 1*SkillLV sec ^000000",
"Cool Down:^777777 2 sec ^000000",
"Duration:^777777 0.2*SkillLV sec ^000000",
"Effect:^777777 Hits every Enemy in a 5x5 area around the targeted cell with 1 Wind Element Bolt per level at a rate of 1 bolt every 0.2 seconds. Each bolt does 0.8*MATK Wind element damage. ^000000",
"[LV 1]^777777 1 Bolt ^000000",
"[LV 2]^777777 2 Bolts ^000000",
"[LV 3]^777777 3 Bolts ^000000",
"[LV 4]^777777 4 Bolts ^000000",
"[LV 5]^777777 5 Bolts ^000000",
"[LV 6]^777777 6 Bolts ^000000",
"[LV 7]^777777 7 Bolts ^000000",
"[LV 8]^777777 8 Bolts ^000000",
"[LV 9]^777777 9 Bolts ^000000",
"[LV 10]^777777 10 Bolts ^000000",
},
</pre>
After Add:
<pre>
[SKID.MG_EARTHBOLT] = {
"Earth Bolt",
"Max Level:^777777 10 ^000000"
"Type:^77777 Active ^000000"
"SP Cost:^777777 20 + 5*SkillLV ^000000"
"Target:^777777 1 Enemy ^000000"
"Cast Time:^777777 2 sec ^000000"
"Cool Down:^777777 1 sec ^000000"
"Duration:^777777 Instant ^000000"
"Effect: ^777777 Deals SkillLV bolts of Earth magic damage to one enemy, at 150% MATK per hit.^000000",
},
</pre>

skilltreeview.lua change:
<pre>
[JOBID.JT_MAGICIAN] = {
[1] = SKID.MG_STONECURSE,
[2] = SKID.MG_COLDBOLT,
[3] = SKID.MG_LIGHTNINGBOLT,
[4] = SKID.MG_NAPALMBEAT,
[5] = SKID.MG_FIREBOLT,
[6] = SKID.MG_SIGHT,
[8] = SKID.MG_SRECOVERY,
[9] = SKID.MG_FROSTDIVER,
[10] = SKID.MG_THUNDERSTORM,
[11] = SKID.MG_SOULSTRIKE,
[12] = SKID.MG_FIREBALL,
[13] = SKID.MG_ENERGYCOAT,
[18] = SKID.MG_SAFETYWALL,
[19] = SKID.MG_FIREWALL
},
</pre>
to:
<pre>
[JOBID.JT_MAGICIAN] = {
[1] = SKID.MG_STONECURSE,
[2] = SKID.MG_COLDBOLT,
[3] = SKID.MG_LIGHTNINGBOLT,
[4] = SKID.MG_NAPALMBEAT,
[5] = SKID.MG_FIREBOLT,
[6] = SKID.MG_SIGHT,
[8] = SKID.MG_SRECOVERY,
[9] = SKID.MG_FROSTDIVER,
[10] = SKID.MG_THUNDERSTORM,
[11] = SKID.MG_SOULSTRIKE,
[12] = SKID.MG_FIREBALL,
[13] = SKID.MG_ENERGYCOAT,
[18] = SKID.MG_SAFETYWALL,
[19] = SKID.MG_FIREWALL,
[20] = SKID.MG_EARTHBOLT
},
</pre>

skillinfolist.lua
Change:
<pre>
[SKID.ECL_SEQUOIADUST] = {
"ECL_SEQUOIADUST";
SkillName = "Sequoia Dust",
MaxLv = 1,
SpAmount = { 0 },
bSeperateLv = false,
AttackRange = { 7 },
}
</pre>
To:
<pre>
[SKID.ECL_SEQUOIADUST] = {
"ECL_SEQUOIADUST";
SkillName = "Sequoia Dust",
MaxLv = 1,
SpAmount = { 0 },
bSeperateLv = false,
AttackRange = { 7 },
},
[SKID.MG_EARTHBOLT] = {
"MG_EARTHBOLT";
SkillName = "Earth Bolt",
MaxLv = 10,
SpAmount = { 25, 30, 35, 40, 45, 50, 55, 60, 65, 70 },
_NeedSkillList = {
{ SKID.MG_FIREBOLT, 5},
{ SKID.MG_LIGHTNINGBOLT, 5}
}
</pre>

=== Finishing up ===

You can add the rest of the information in skillnametable.txt, skilldesctable2.txt and you'll need to add the appropriate Sprite and BMP file for the skill. Use the name MG_EARTHBOLT as the name of the file, and for the entries in the two text files.

[[Category:Source Snippets]]
[[Category:Customization]]

Adding New Mapflag

2013-12-25T10:50:29Z

Sevenzz23:

== Introduction ==

When scripting, or creating custom automated events, you may wish to add your own custom mapflags. In order to do so, you'll need to complete some source edits. This article will explain how.

----

This article was originally created by [http://www.eathena.ws/board/index.php?showuser=273955 TecnoCronus] on the eAthena forums.

== Adding your mapflag ==

=== Open /src/map/map.h ===
----
'''Find:'''
unsigned src4instance : 1; // To flag this map when it's used as a src map for instances

'''Add below:'''
unsigned mymapflag : 1;

=== Open /src/map/map.c ===
----
'''Find:'''
} else if (!strcmpi(flag,"nocashshop")) {
if( state && map->list[m].flag.nocashshop )
;/* nothing to do */
else {
if( state )
map_zone_mf_cache_add(m,"nocashshop\toff");
else if( map->list[m].flag.nocashshop )
map_zone_mf_cache_add(m,"nocashshop");
}
}

'''Add below:'''
else if( !strcmpi(flag,"mymapflag")) {
if( state && map->list[m].flag.mymapflag )
; /* nothing to do */
else {
if( state )
map_zone_mf_cache_add(m,"mymapflag\toff");
else if( map->list[m].flag.mymapflag )
map_zone_mf_cache_add(m,"mymapflag");
}
}

=== Open /src/map/script.h ===
----
'''Find:'''
MF_NOCASHSHOP

'''Replace with:'''
MF_NOCASHSHOP,
MF_MYMAPFLAG

=== Open /src/map/script.c ===
----
'''Find:'''
case MF_GUILDLOCK: script_pushint(st,map->list[m].flag.guildlock); break;

'''Below add:'''
case MF_MYMAPFLAG: script_pushint(st,map->list[m].flag.mymapflag); break;

----

'''Find:'''
case MF_GUILDLOCK: map->list[m].flag.guildlock=1; break;

'''Below add:'''
case MF_MYMAPFLAG: map->list[m].flag.mymapflag=1; break;

----

'''Find:'''
case MF_GUILDLOCK: map->list[m].flag.guildlock=0; break;

'''Below add:'''
case MF_MYMAPFLAG: map->list[m].flag.mymapflag=0; break;

=== Open /src/map/npc.c ===
----
'''Find:'''
else if (!strcmpi(w3,"guildlock"))
map->list[m].flag.guildlock=state;

'''Below add:'''
else if (!strcmpi(w3,"mymapflag"))
map->list[m].flag.mymapflag=state;

=== Open /db/const.txt ===
----
'''Find:'''
mf_guildlock<tab>45

'''Below add:'''
mf_mymapflag<tab>46

== Listing your mapflag in atcommands ==

=== Open /src/map/atcommand.c ===
----
'''Find:'''
if (map->list[m_id].flag.nomemo)
strcat(atcmd_output, msg_txt(1064)); // NoMemo |

'''Below add:'''
if (map->list[m_id].flag.mymapflag)
strcat(atcmd_output, "mymapflag |");

'''Find:'''
CHECKFLAG(nocashshop);

'''Below add:'''
CHECKFLAG(mymapflag);

'''Find:'''
SETFLAG(nocashshop);

'''Below add:'''
SETFLAG(mymapflag);

'''Find:'''
clif->message(sd->fd,"guildlock, src4instance, notomb, nocashshop");

'''Replace it with:'''
clif->message(sd->fd,"guildlock, src4instance, notomb, nocashshop, mymapflag");

== Conclusion ==

Recompile and you can now set "mymapflag" to any value. Remember, you can rename the mapflag to whatever, and later use the flag option anywhere else in your source code.

[[Category:Source Snippets]]

Custom weapons

2013-12-23T07:19:09Z

Sevenzz23: /* The ID */

== The ID ==
Why the ID first? The ID controls what type of weapon sprite is displayed. Going outside the ID range will cause you to "punch" when attacking.

Open your {{git|db/re/item_db.conf}} or {{git|db/pre-re/item_db.conf}} and find the section with the weapon type you need. The allowable range is usually obvious.

{| {| class="wikitable" border="1"
!Item ID
!Item Type
|-
|1100-1149, 13400-13499||One-Handed Swords
|-
|1150-1199, 21000-21999||Two-Handed Swords
|-
|1200-1249, 13000-13099||Knives, Daggers, Etc.
|-
|1250-1299||Katars
|-
|1300-1349||One-Handed Axes
|-
|1350-1399||Two-Handed Axes
|-
|1400-1449||One-Handed Spears
|-
|1450-1471, 1474-1499||Two-Handed Spears
|-
|1500-1549, 16000-16999||Maces
|-
|1550-1599||Books
|-
|1600-1699||One Handed Rods/Staves
|-
|1700-1749, 18100-18499||Bows
|-
|1750-1799||Arrows
|-
|1800-1849||Knuckles
|-
|1900-1949||Guitars/Instruments
|-
|1950-1999||Whips
|-
|1472,1473,2000-2099||Two Handed Rods/Staves
|-
|13100-13149||Handgun
|-
|13150-13199||Other Guns
|-
|13300-13399||Ninja Weapons
|}

=== Example ===

To make a custom bow, searching for "Bows" in item_db shows that bow IDs start at 1701 and end at 1749. Since there are no remaining IDs, commenting out an unused bow would work.

Otherwise, skip to the next set of bows, which start at 18101. Select an open ID in that range.

== The Sprite ==
The client requires a sprite for every job the weapon can be used by. Some programs can automatically organize the files:
* [http://rathena.org/board/files/file/2494-ra-sprite-name-gen/ clydelion's Sprite Name Generator] 
* [http://rathena.org/board/files/file/2386-ea-sprite-name-generator/ Myzter's Sprite Name Generator]

Don't forget to give the weapon an icon in '''/sprite/¾ÆÀÌÅÛ/''', as well as an inventory icon and collection image in '''/texture/À¯ÀúÀÎÅÍÆäÀÌ½º/item/''' and '''/texture/À¯ÀúÀÎÅÍÆäÀÌ½º/collection/'''.

== Other Client Data ==
Lastly, the client data tables need to be filled out:

*'''idnum2itemdesctable.txt''': Identified item description.
*'''idnum2itemdisplaynametable.txt''': Identified item display name.
*'''idnum2itemresnametable.txt''': Identified sprite name.
*'''itemslotcounttable.txt''': Number of weapon slots, if necessary (skip if 0).
*'''num2itemdesctable.txt''': Unidentified item description, if necessary.
*'''num2itemdisplaynametable.txt''': Unidentified item display name, if necessary.
*'''num2itemresnametable.txt''': Unidentified sprite name, if necessary.

''And... you are done!''

== Troubleshooting ==
'''Q: Weapon is an Unknown Item.'''

A: An error in resnametable. The client is not reading any value, so it becomes unknown.

'''Q: The weapon sprite shows fine when standing, turns to punches when attacking.'''

A: The ID for the weapon isn't in the allowed range. Make sure the value is correct.

'''Q: The weapon sprite doesn't show at all.'''

A: Re-check file/folder names and placement.

[[Category:Customization]]

Changebase

2013-12-14T03:32:30Z

Sevenzz23: Created page with "== Syntax == * changebase <job ID number>; == Description == This command will change the appearance of the invoking character to that of a specified job class. Nothing b..."

== Syntax ==
* [[changebase]] <job ID number>;
== Description ==
This command will change the appearance of the invoking character to that
of a specified job class. Nothing but appearance will change.

== Examples==

2338,Wedding_Dress,Wedding Dress,5,43000,,500,,0,,0,119529470,7,0,16,,0,1,0,{ bonus bMdef,15; changebase 22; }

changebase Job_Novice; // Changes player to Novice sprite.

changebase Class; // Changes player back to default sprite.

[[Category:Script_Command]]

Custom Items

2013-12-13T17:59:51Z

Sevenzz23: /* Structure */

=Structure=
First, let's take a look at the item_db.conf in the db folder, and its structure:
item_db: (
{
// =================== Mandatory fields ===============================
Id: ID (int)
AegisName: "Aegis_Name" (string, optional if Inherit: true)
Name: "Item Name" (string, optional if Inherit: true)
// =================== Optional fields ================================
Type: Item Type (int, defaults to 3 = etc item)
Buy: Buy Price (int, defaults to Sell * 2)
Sell: Sell Price (int, defaults to Buy / 2)
Weight: Item Weight (int, defaults to 0)
Atk: Attack (int, defaults to 0)
Matk: Magical Attack (int, defaults to 0, ignored in pre-re)
Def: Defense (int, defaults to 0)
Range: Attack Range (int, defaults to 0)
Slots: Slots (int, defaults to 0)
Job: Job mask (int, defaults to all jobs = 0xFFFFFFFF)
Upper: Upper mask (int, defaults to any = 0x3f)
Gender: Gender (int, defaults to both = 2)
Loc: Equip location (int, required value for equipment)
WeaponLv: Weapon Level (int, defaults to 0)
EquipLv: Equip required level (int, defaults to 0)
EquipLv: [min, max] (alternative syntax with min / max level)
Refine: Refineable (boolean, defaults to true)
View: View ID (int, defaults to 0)
BindOnEquip: true/false (boolean, defaults to false)
Script: <"
Script
(it can be multi-line)
">
OnEquipScript: <" OnEquip Script (can also be multi-line) ">
OnUnequipScript: <" OnUnequip Script (can also be multi-line) ">
// =================== Optional fields (item_db2 only) ================
Inherit: true/false (boolean, if true, inherit the values
that weren't specified, from item_db.conf,
else override it and use default values)
},
...
)

* '''ID''': ID of the item.
* '''AegisName''': Server name to reference the item in scripts and lookups, should use no spaces.
* '''Name''': Name in English for displaying as output for @ and script commands.
* '''Type''': Purpose of the item.
0 = Usable : healing
2 = Usable : other
3 = Misc
4 = Weapon
5 = Armor
6 = Card
7 = Pet Egg
8 = Pet Equipment
10 = Arrow/Ammunition
11 = Usable : delayed consumption (items with script "pet" or "itemskill")
18 = Another delayed consume that requires user confirmation before using item.
* '''Buy''': Default [[NPC]] buying price in Zeny. When not specified, becomes double the sell price.
* '''Sell''': Default [[NPC]] selling price in Zeny. When not specified, becomes half the buy price.
* '''Weight''': Item's weight. Each 10 is 1 weight. When not specified, becomes 0.
* '''ATK''': Base weapon attack, in case of a weapon. When not specified, becomes 0.
** In '''RE''' enabled servers this field have a optional delimiter ''':''' to define this item's weaponMATK bonus, for example, '''30:50''' would mean the item gives 30 atk and 50 weaponMATK
* '''Matk''': Weapon's magical attack (only used in renewal mode, ignored in pre-renewal). When not specified, becomes 0.
* '''DEF''': Base defense for armor-type items. When not specified, becomes 0.
* '''Range''': Maximum range in map cells a weapon allows to be the player apart from it's target. When not specified, becomes 0.
* '''Slots''': Amount of card slots in weapon/armor-type items. When not specified, becomes 0.
* '''Job''': Which jobs this item is available for. Values below can be combined to achieve availability for multiple job classes, i. e. <code>0x2|0x4 -> 0x6</code> (Swordman+Mage)
(S.) Novice (2^00): 0x00000001
Swordman (2^01): 0x00000002
Mage (2^02): 0x00000004
Archer (2^03): 0x00000008
Acolyte (2^04): 0x00000010
Merchant (2^05): 0x00000020
Thief (2^06): 0x00000040
Knight (2^07): 0x00000080
Priest (2^08): 0x00000100
Wizard (2^09): 0x00000200
Blacksmith (2^10): 0x00000400
Hunter (2^11): 0x00000800
Assassin (2^12): 0x00001000
''Unused'' (2^13): 0x00002000
Crusader (2^14): 0x00004000
Monk (2^15): 0x00008000
Sage (2^16): 0x00010000
Rogue (2^17): 0x00020000
Alchemist (2^18): 0x00040000
Bard/Dancer (2^19): 0x00080000
''Unused'' (2^20): 0x00100000
Taekwon (2^21): 0x00200000
StarGladiator (2^22): 0x00400000
Soul Linker (2^23): 0x00800000
Gunslinger (2^24): 0x01000000
Ninja (2^25): 0x02000000
Gangsi (2^26): 0x04000000
Death Knight (2^27): 0x08000000
Dark Collector (2^28): 0x10000000
Kagerou/Oboro (2^29): 0x20000000
Rebellion (2^30): 0x40000000
'''Some other commonly used values:'''
All Classes : 0xFFFFFFFF
Every Job Except Novice : 0xFFFFFFFE
* '''Upper''': Specifies whether the item can be used by normal, baby or reborn classes. Values below can be combined, i. e. <code>1|4 -> 5</code> (Normal+Baby Classes)
** Note: Setting <code>2</code> enables the item for Transcendant and 3rd classes. Use <code>8</code> to enable the item for 3rd classes only.
Normal jobs: 0x01 (1)
Upper jobs: 0x02 (2)
Baby jobs: 0x04 (4)
Third jobs: 0x08 (8)
Upper Third jobs: 0x10 (16)
Baby Third jobs: 0x20 (32)

Under pre-re mode third classes are considered upper, making use of
the 8 and above masks is therefore not necessary unless in renewal
mode. When no value is specified, all classes (mask 0x3f) are able to
equip the item.
* '''Gender''': Gender restriction for the item.
0 = Female
1 = Male
2 = No restriction (both)
* '''Loc''': Equipment location of armor and arrow-type items. Values below can be combined, i. e. 136 would indicate both accessory slots (typical value for accessories).
(2^0) 1 = Lower headgear
(2^1) 2 = Right hand
(2^2) 4 = Mantle
(2^3) 8 = Accessory 1
(2^4) 16 = Armor
(2^5) 32 = Left hand
(2^6) 64 = Shoes
(2^7) 128 = Accessory 2
(2^8) 256 = Upper headgear
(2^9) 512 = Middle headgear
(2^10) 1024 = Costume Top Headgear
(2^11) 2048 = Costume Mid Headgear
(2^12) 4096 = Costume Low Headgear
(2^13) 8192 = Costume Garment/Robe
(2^15) 32768 = Arrow (arrow-type items only)
(2^16) 65536 = Shadow Armor
(2^17) 131072 = Shadow Weapon
(2^18) 262144 = Shadow Shield
(2^18) 524288 = Shadow Shoes
(2^20) 1048576 = Shadow Accessory 2
(2^21) 2097152 = Shadow Accessory 1
* '''WeaponLv''': Weapon level of an item (1-4), Becomes 0 when not specified.
* '''EquipLv''': Base level required to be able to equip. It is possible to specify two values, if an item has a maximum level, by using the following syntax:
EquipLv: [minLv, maxLv]

If only one value is specified, maxLv becomes the current server's
MAX_LEVEL. If no values are specified, minLv becomes 0.
* '''Refineable''': Whether the item is available for refining (1) or not (0). If no value is specified, it defaults to true.
* '''View''': For normal items, defines a replacement view-sprite for the item
:(eg: Making apples look like apple juice). The special case are weapons and ammo where this value indicates the weapon-class of the item.
** Weapon-type items:
**# Daggers
**# One-Handed Swords
**# Two-Handed Swords
**# One-Handed Spears
**# Two-Handed Spears
**# One-Handed Axes
**# Two-Handed Axes
**# Maces
**# ''(not used)''
**# Wand/Staff
**# Bows/Crossbows
**# Knuckle Weapons
**# Musical Instruments
**# Whips
**# Books
**# Katars
**# Revolvers
**# Rifles
**# Shotguns
**# Gatling guns
**# Grenade launchers
**# Fuuma shuriken
** Shield-type items:
**# Guard, Novice Guard
**# Buckler
**# Shield, Holy Guard, Evangelist
**# Mirror Shield
** Ammunition-type items:
**# Arrows
**# Throw-able daggers
**# Bullets
**# Shells
**# Grenades
**# Shuriken
**# Kunai
**# Cannonballs
**# Throwable Items (Sling Item)
** Headgear-type items: Please see the View IDs section of this guide.
* '''BindOnEquip''': Whether the item will automatically bind to the character when it is equipped for the first time.
:An item that has this field set, will display a confirmation dialog the first time it is equipped, and, if accepted, the item will become character-bound.
* '''Script''': This is where you put your item bonus. Whether it's an usable item or an equip item, it will take effect according to the item type.
* '''OnEquip_Script''': Script to execute when the item is equipped. Warning, not all item bonuses will work here as expected.
* '''OnUnequip_Script''': Script to execute when the item is unequipped. Warning, not all item bonuses will work here as expected.
* '''Inherit''': This can be used only in item_db2.conf, and if set to true, and the item already exists in item_db.conf,
:all the missing fields will be inherited from there rather than using their default values.
 
In the doc folder look for a text file called "item_bonus", it shows all the scripts items can have and how they work.
 
For more information about this structure read [http://hercules.ws/board/topic/2954-item-db-file-structure-overhaul/ Item DB file structure overhaul]

=Item Placement on Data Folder (Renewal Clients <= 2012-04-10a & Main Clients <= 2012-07-10a) =
After you make your item, put it in your item_db2.txt, so that you will not run into conflicts when updating the SVN later. Then go to your data folder and modify the following files, one after another.

==idnum2itemdisplaynametable.txt==
This file holds the item names, as displayed inside the client. Each item added as:
ItemID#ItemName#
ItemID is the number from your ID column inside the item db. If your item name contains spaces, replace those with _ (underscore).

==idnum2itemdesctable.txt==
This file contains the description of your item, when it is right-clicked. The syntax for an item is:
ItemID#
Item Description Line 1
Item Description Line 2
#
You can use any amount of lines for the description. If your description contains a #, make sure it is followed by a space character.
==idnum2itemresnametable.txt==
This file sets the inventory and drop-sprite for an the item. Item is defined as follows:
ItemID#SpriteName#
The SpriteName is the name of the files in collection and item folders inside texture and the ones inside sprite folder. If you want to use the look of an another item, search for it's id and copy the sprite name from there.
==itemslotcounttable.txt==
In this file you set the amount of visible slots for the item. You do not need to add 0 slot items or items, which do not have slots at all (i. e. usable items). Syntax:
ItemID#NumberOfSlots#
NumberOfSlots should be a number from 1-4, larger values might have undesired effects.
==Files for non-identified items==
The following files specify the name, description and look for items, which have not yet been identified. Their syntax follows the same rules as for the files with ''idnum'' prefix. Normally the same text is entered for non-equipment and generic description (which can be copied from official items) is used for equipment of all sorts (weapons, armor, headgears).
* num2itemdesctable.txt
* num2itemdisplaynametable.txt
* num2itemresnametable.txt

=Item Placement on Data Folder (For New Clients)=
If your client date is newer than specified above then you need to specify all the above item information in 1 file

==System/ItemInfo.lub==
Since ItemInfo.lub is compiled, you need to decompile it to lua , add your customs and recompile back to lub file (Some have said that renaming a decompiled file to lub also works)
Syntax:
[<item id>] = {
unidentifiedDisplayName = <item name to show when not magnified>,
unidentifiedResourceName = <file name prefix used for all the images and drop sprite when not magnified>,
unidentifiedDescriptionName = { <comma separated list of strings>,<to get multiple lines>,<in item description> },
identifiedDisplayName = <item name to show when magnified>,
identifiedResourceName = <file name prefix used for all the images and drop sprite when magnified>,
identifiedDescriptionName = { <same format as unidentifiedDescriptionName but for magnified items> },
slotCount = <number of slots>,
ClassNum = <View ID - yes the same one that was there item_db>
},
For Weapons, ClassNum = View ID specified in Weapon_IDs table (inside weapontable.lub file). Look [[Custom_Items#Weapon_Sprite_Solution_.28For_New_Clients.29|below]] for details.

You can also put the different values in DescriptionName in separate lines.

Example: Lets say i want to add a weapon to item id 25000 - a One handed sword named Devastator with 3 slots & the image files & drop sprite files are all named Black_Sword.* . Also i want to display a Sword when not magnified.

[25000] = {
unidentifiedDisplayName = "Sword",
unidentifiedResourceName = "¼Òµå",
unidentifiedDescriptionName = { "Unidentified item, can be identified with [Magnifier]." },
identifiedDisplayName = "Devastator",
identifiedResourceName = "Black_Sword",
identifiedDescriptionName = {
"An Unholy Sword that was created with the sole purpose of destruction",
"Class :^777777 Sword^000000",
"Attack :^777777 325^000000",
"Weight :^777777 80^000000",
"Weapon Level :^777777 4^000000",
"Required Level :^777777 100^000000",
"Applicable Job :^777777 Novice, Swordsman Class, Merchant Class, Thief Class^000000"
},
slotCount = 3,
ClassNum = 2
},

= Allocating Items on Client Side =
Your custom item will have 4 (6 in case its a headgear or garment) files:
1) Drop sprite -> Helmet_drop.spr
2) Drop act file -> Helmet_drop.act
3) Item Inventory image -> Helmet_item.bmp
4) Item Collection image -> Helmet_collection.bmp (the one you see on its description window)
5) Headgear View sprite -> Helmet.spr
6) Headgear View act file -> Helmet.act

Lets say i downloaded a custom item called Helmet which serves as a headgear and the above six files were in them.

==Step 1:==
We place the first four files based on what we specified in id2numresnametable.txt (IdentifiedResourceName in Iteminfo.lub).
For our example lets say i used "Helmet" as the resource name :
i) Copy Helmet_drop.spr to [RO Folder]\data\sprite\¾ÆÀÌÅÛ\Helmet.spr
ii) Copy Helmet_drop.act to [RO Folder]\data\sprite\¾ÆÀÌÅÛ\Helmet.act
iii) Copy Helmet_item.bmp to [RO Folder]\data\texture\À¯ÀúÀÎÅÍÆäÀÌ½º\item\Helmet.bmp
iv) Copy Helmet_collection.bmp to [RO Folder]\data\texture\À¯ÀúÀÎÅÍÆäÀÌ½º\collection\Helmet.bmp
==Step 2 (only for Headgears):==
For displaying headgear on the character there will be two additional files (sprite & act) or 4 if the sprite author intended for a separate set of files for male & female. In my example i have considered the first scenario.

The filename for headgear sprite are now specified in accname.lua file (details of which is available in the [[Custom_Items#View_IDs.2C_Having_A_Custom_Headgear_Without_Xray|View IDs Section]])

lets say i used
[ACCESSORY_IDs.HELMET] = "_Helmet",
then we need to:
i) Copy Helmet.spr to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\¿©\¿©_Helmet.spr (Female)
ii) Copy Helmet.act to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\¿©\¿©_Helmet.act
iii) Copy Helmet.spr to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\³²\³²_Helmet.spr (Male)
iv) Copy Helmet.act to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\³²\³²_Helmet.act

Now it is ready to be used provided you have added entries properly to the lua files.

==Specifications of the files==
1) Drop sprites - ideally have 1 frame & its act file will be just an empty act (only header will be there inside)

2) Equip sprites - typically have 3+ frames to show images for various orientations & its act file will have the info on where to place each frame.

3) Item bmp - 24x24 size 256 bit bmp file.

4) Collection bmp - 75x100 size bmp file (usually 256 bit but there is no restriction)

How to differentiate between sprite files?

Open both sprite files in [http://ratemyserver.net/download_agent.php?type=1&file_num=10 Spr Conview]. The number of frames in the files can be seen at bottom (Sprite: <currentframe>/<total>). If it says Sprite: 1/1 then its a drop sprite and the other is equip sprite.

Sometimes what sprite authors do is they simply copy the original sprite itself to make a drop sprite. In this case you will see both of them as identical when opened in Spr Conview & we don't need to worry about which one is which (since they are the same).

If the process confused you, [http://www.mediafire.com/?8lzt4cbot100w44 here is an example folder], the sprite is done by drkangel. The folder is virus free.

= View IDs, Having A Custom Headgear Without Xray =
Look in your data folder and make sure there is a folder named "lua files", if there is not make it.[http://svn6.assembla.com/svn/ClientSide/Lua_Project/lubs/ Download the most recent lub package] and extract it to your lua files folder in your data folder. [http://svn6.assembla.com/svn/ClientSide/Lua_Project/lua%20files/datainfo/ Download the most recent accname.lua and accessoryid.lua], put it in your datainfo folder that is inside the lua files folder. Now download [http://svn6.assembla.com/svn/ClientSide/Lua_Project/tool/luac5.0.2.exe this lub compiling tool], and put it in the datainfo folder.
Now, Open accessoryid.lua in the datainfo folder with notepad or a text editor of your choice, go all the way down until the names stop. Add your custom gears before the } symbol. You should use a high number just like with your custom item's database ID, or use unused IDs to be sure you won't have to redo them all in the future, or at least for a while. Example:
ACCESSORY_PINKBUNNY_HAIRBAND = 663,
ACCESSORY_GREENBUNNY_HAIRBAND = 664,
ACCESSORY_OLD_ELFEAR = 665,
ACCESSORY_THA_MAERO_MASK = 666,
ACCESSORY_THANATOS_MAI_MASK = 667,
--668 free
ACCESSORY_FISHPIN = 669,
ACCESSORY_CUSTOM_HAT = 900,
}

''You must compile to lub if you leave space between IDs, if you don't plan on compiling to lub, make sure you do not skip any numbers.''

Now open accname.lua, do basically the same thing but just in a different way, and for the sprite. Add your item to the bottom, have it look like the ones above it, except have your items name and the item's sprite name.
[ACCESSORY_IDs.ACCESSORY_PINKBUNNY_HAIRBAND] = "_ÇÎÅ©Åä³¢¸Ó¸®¶ì",
[ACCESSORY_IDs.ACCESSORY_GREENBUNNY_HAIRBAND] = "_±×¸°Åä³¢¸Ó¸®¶ì",
[ACCESSORY_IDs.ACCESSORY_OLD_ELFEAR] = "_°í´ë¿äÁ¤ÀÇ±Í",
[ACCESSORY_IDs.ACCESSORY_THA_MAERO_MASK] = "_Å¸³ªÅä½ºÀÇ½½ÇÄ°¡¸é",
[ACCESSORY_IDs.ACCESSORY_THANATOS_MAI_MASK] = "_Å¸³ªÅä½ºÀÇÁõ¿À°¡¸é",
[ACCESSORY_IDs.ACCESSORY_FISHPIN] = "_¹°°í±âÇÉ",
[ACCESSORY_IDs.ACCESSORY_CUSTOM_HAT] = "_Sprite_Name_Here",
}
Delete the accname.lub and accessoryid.lub. Now that you are done, make sure luac.exe is in your datainfo folder, right click the luac.exe, create a shortcut, right click the shortcut, and click properties, in the target area, add right after the quotes, with the quotes:
-o "accessoryid.lub" "accessoryid.lua"
So that it looks something like this:
"C:\Program Files (x86)\Gravity\RO\data\lua files\datainfo\luac5.0.2.exe" -o "accessoryid.lub" "accessoryid.lua"
Do this also to "accname.lub" except instead of accessoryid in the quotes, do accname. If there is any lua file leftover, you may want to move it somewhere else just for future changes, like My Documents. For future reference, this is also how you turn the other lub files to lua files.

=Modifications=
==Sprite Replacement==
To replace a headgear with your customized headgear, just delete one of the items you want, and replace your customised item ID with that id.

Lets say you have something like this:
15000,Angel_Wing,Angel Wing,4,,10,10,0,,1,0,0,3,0,0,0,0,0,{},{},{}
And there's an item you wont need, such as:
2220,Hat,Hat,5,1000,,200,,2,,0,10477567,2,256,,0,1,16,{},{},{}
Well, to replace it, just delete everything in the hat line but its ID, and paste there your custom item, all the line but the ID. Should be like this:
'''2220''',Hat,Hat,5,1000,,200,,2,,0,10477567,2,256,,0,1,16,{},{},{}
15000,'''Angel_Wing,Angel Wing,4,,10,10,0,,1,0,0,3,0,0,0,0,0,{},{},{}'''
'''2220,Angel_Wing,Angel Wing,4,,10,10,0,,1,0,0,3,0,0,0,0,0,{},{},{}'''
All you need to do now is changing the View ID to the Hat, and change your file names to its name. You can find them on the idnum2resnametable.txt Search for 2220 and the gibberish besides it, w/o the # # is the file name, then rename it to your custom item name.

Remember to add the files to data\sprite\¾ÆÀÌÅÛ (Icon sprite) and both data\sprite\¾Ç¼¼»ç¸®\³² (Male Item Sprite) and data\sprite\¾Ç¼¼»ç¸®\¿© (Female Item Sprite). Remember, these 2 last item names, must have either a ³²_ for male or ¿©_ for female, at the beginning of the name, both .spr and .act. Also, don't forget to change the other files:

idnum2itemdisplaynametable.txt , idnum2itemdesctable.txt , idnum2itemdesctable.txt , num2itemdesctable.txt , num2itemdisplaynametable.txt , num2itemresnametable.txt and itemslotcounttable.txt

Use these files if you want to replace sprites, they will be useful.
* '''actOR:''' with the actor you modify the act file, which is the one who tells the client where does the weapon go and what does it have to do and at a certain moment.
* '''SPR Conview:''' you can use these to view which sprite is which, and also see sequence per sequence.

==Item Restrictions==
Look on your db folder for a file called item_trade.txt and open it

Now, the pattern for a flag is:

Item ID, TradeMask, GM-Level Override

* '''Item ID''': the ID of your item.
* '''TradeMask''': Testrictions the item will have, such as being dropped, stored or traded. These values can be combined to achieve multiple effects.
1:Item can't be dropped
2:Item can't be traded (nor vended)
4:Item can only be traded with wedded partner
8:Item can't be sold to NPCs
16:Item can't be placed in the cart
32:Item can't be placed in the storage
64:Item can't be placed in the guild storage
* '''GM-Level Override''': This is the minimum GM level a player must have to avoid these restrictions.

==Item Script==
{{duplication
|type=section
|what=[[itemskill]], [[sc_start]] and [[skilleffect]]}}
{{disputed
|type=section
|date=September 2010}}
Okay, I'll update this as I go; otherwise, I wont have anything new to show. First with usable items.

Well, there are 3 types of usables:

1.- Healing items, they have in the type field a 0.

2.- Other uses items, such as fly wings and so, which doesn't heal, but does have an instant effect, they have in the type field a 2.

3.- Usable items, which are skills that requires a target selection, therefore they have a delayed use, and in newer SVNs the item wont be gone until the target is chosen and the cast has finished. Means, you wont lose the item if the skill hasn't been done. They have in the type field an 11.

Now, for an item skill, the pattern for a skill is:
itemskill <skill id>,<skill level>;
Without <> of course.

Now, we go to our db\skill_db.txt and search for the blessing ID, searching for AL_ or blessing, but first, the structure of a skill:
id,range,hit,inf,element,nk,splash,max,list_num,castcancel,cast_defence_rate,inf2,maxcount,skill_type,blow_count,name,description
Now, the AL_BLESSING or Blessing Skill:
34,9,6,16,0,0x1,0,10,1,yes,0,0,0,magic,0, AL_BLESSING,Blessing
We grab the ID and put it on our code:
itemskill 34,<skill lvl>;
Don't mind the actual level of the skill_db.txt for the skill level part. You can actually put the level you want here below 99, so lets pick 4:
itemskill 34,4;
And finally, insert it on the code.
<pre>,{ itemskill 34,4; },{},{}</pre>

There, we have a Lvl 4 Blessing item skill.

Remember, one space before and one after the script, NOT TAB!

And so on with other skills. Just remember these steps and they should be fine. And remember, itemskill is NOT the same as skill. itemskill will make you CAST that skill, while skill will GIVE you the skill. If you give an item, whether delayed use or normal usable two itemskill commands, only the latter will come into effect, as you cannot cast two skills at the same time.

Now, for Potions.

Instead of using itemskill, we will use itemheal:
,{ itemheal 100,0; },{},{}
The green is the HP, the blue is the SP. To add that random heal amount effect, just pick a set amount, let's say 120, then pick 1 or 2 numbers, up to you. Then, add the rand() command, like this:
,{ itemheal rand(120,9,49),0; },{},{}
Explanation: This item will heal about 49~120 hp and 0 SP. To heal SP you change the 0 to a number. Like this:
,{ itemheal rand(120,9,49),50; },{},{}
It will now heal 50 SP.
Now, for skilleffect and sc_start.

Okay, let's see. Here's a example of an item casting a skill and simulating a skill.
,{ itemskill 34,10; skilleffect 29,0; sc_start 12,140000,5; },{},{}
skilleffect will display on your client a skill visual effect. The pattern is:

skilleffect <skill ID>,<number>;

;skill ID
:Self-explanatory.
;number
:Have you seen those skills that shows up numbers upon casting? Such as heal? Well, putting a number there will display it. But only works on skills with numbers floating.

sc_start has the following pattern:

sc_start <status id>,<duration>,<val1>[,<unit id>];

;status id
:Refer to const.txt in your db folder for all effects. Open it with a text editor then search by either clicking edit, then find, or press and hold the ctrl key, and while still holding it press the f key, then release, and search for "SC_ALL -1". Everything below this is an effect. The effects stop at "e_gasp 0" which are emoticons.
;duration
:Is the amount time in milliseconds (1000 msec = 1 sec) that the status will be active.
;val1
:Typically it's the level of the skill, associated with this status.
;unit id
:Allows to start the status on an other unit, than the attached player. For players this is account id. This parameter is optional, and can be omitted.

Now, for the item I said, it will show you the visual effect of Blessing and cast on you a lvl 5 Agi-Up! skill for 140 seconds.

For more item scripts see script_commands.txt in your doc folder, as well as item_bonus.txt in your doc folder.

==Weapon Sprite Solution (Renewal Clients <= 2012-04-10a & Main Clients <= 2012-07-10a)==
For these clients, Weapons are limited to use a range of Item IDs hardcoded in the clientn for each type.
For e.g.

1265,Bloody_Roar,Bloody Roar,4,,10,1000,120,,1,0,4096,7,2,34,4,75,1,16,{ bonus bIgnoreDefRace,RC_DemiHuman; bonus bFlee,-160; bonus bFlee2,-160; bonus bNoRegen,1; bonus bNoRegen,2; },{},{}
1266,Test,Test,4,4000,2000,10,165,,1,0,4096,7,2,34,3,33,1,16,{}

// 1-Handed Axes
1301,Axe,Axe,4,500,,800,38,,1,3,8803555,7,2,2,1,3,1,6,{}

Here the item 1266 is a custom katar and it does show up as a katar (if you have the proper sprite files ofcourse). but if i use some id like say 22000, client wont display it. So what is the range of item ids you can use? Look below:

* One handed Swords = 1100-1149, 13400-13499
* Two handed Swords = 1150-1199, 21000-21999

* Knives, Daggers etc = 1200-1249, 13000-13099
* Katars = 1250-1299 ; Has 35 free IDs

* One handed Axes = 1300-1349; Has 43 free IDs
* Two handed Axes = 1350-1399; Has 32 free IDs

* One handed Spears = 1400-1449; Has 34 free IDs
* Two Handed Spears = 1450-1471, 1474-1499

* Maces = 1500-1549, 16000-16999
* Books = 1550-1599 ; Has only 2 IDs.
* Knuckles = 1800-1899 ; Has 95 free IDs

* One Handed Staves/Rods = 1600-1699; Has 79 free IDs
* Two Handed Staves/Rods = 1472,1473,2000-2099

* Bows = 1700-1749, 18100-18499
* Guitars = 1900-1949 ; Has 32 free IDs
* Whips = 1950-1999 ; Has 130 free IDs

* Handguns = 13100-13149
* Other guns = 13150-13199

* Ninja weapons = 13300-13399

The number of unused Item IDs left known for a range has also been mentioned above. Best practice to follow check in your range in official db before adding custom weapon.

==Weapon Sprite Solution (For New Clients) ==
For new clients the view id system is also applicable to client. To add a custom weapon you need to first edit a file
called weapontable.lub in your data folder
data/luafiles514/lua files/datainfo/weapontable.lub

I will be adding Oriental_Sword which will be a 1-Handed sword. Open weapontable.lub.
First you will see a table called Weapon_IDs. Take note of the first 30 values in this table - these are the only available Weapon types in the client right now.

Anyways go to the last entry which should be for Wizardy Staff = 97. You can use a view id after that like shown below
WEAPONTYPE_Oriental_Sword = 98,

Come down and you see the next table called WeaponNameTable. Here is where you add your sprite name suffix. 
What do i mean by that? Its the last part in your weapon sprite & act file. Before it used to be _<Item ID>.
data/sprite/<job dependent folder>/<job dependent prefix>_<gender><weapon suffix>.spr

OK Back to topic. so I add my entry like shown below.
[Weapon_IDs.WEAPONTYPE_Oriental_Sword] = "_Oriental"

Lastly come down further in weapontable.lub and you see the last table called Expansion_Weapon_IDs. 
Remember the 30 types i told you to take note of ? here we assign one of those to our custom (like a mapping or connection). 
Since mine is a 1-Handed Sword I specify it like below.
[Weapon_IDs.WEAPONTYPE_Oriental_Sword] = Weapon_IDs.WPCLASS_WEAPONTYPE_SWORD

Now for the most important part. For our client to actually pick up all these details we need to provide the view id which we used in Weapon_IDs table as the ClassNum value in ItemInfo.lua. Check the [[Custom_Items#System.2FItemInfo.lub|ItemInfo.lub format]] shown above for details.

With this your weapon sprite will become visible while attacking.
[[Category:Database]]
[[Category:Data]]
[[Category:Customization]]

Removemapflag

2013-12-06T23:42:13Z

Sevenzz23: /* Description */

==Syntax==
* [[removemapflag]] "<map name>",<flag>;
==Description==
This command checks the status of a given mapflag and returns the
[[mapflag]]'s state.
0 means OFF, and 1 means ON. See [[setmapflag]] for a list of [[mapflags]].
[[Category:Script_Command]]

Building HPM Plugin for MSVC

2013-12-06T07:43:49Z

Sevenzz23: /* 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");

addAtcommand("dance",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. Add your code to the '''dance.c''' file, and then right-click the project you created, and select '''Build'''

18. Add it to ''' /conf/plugins.conf'''

<pre>
plugins_list: [
/* Enable HPMHooking when plugins in use rely on Hooking */
//"HPMHooking",
//"db2sql",
//"sample",
//"other",
"dance", // dance.c
]
</pre>

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

[[Category:Installation]]

Hercules Plugin Manager

2013-12-06T07:19:33Z

Sevenzz23: /* HPM Custom Packets */

Often referred to as the [[HPM]], the '''Hercules Plugin Manager''' is yet another [[Hercules Original]]
= Building a plugin =
While the [[C]] code for the plugin normally won't have discrepancies, in order to [[compile]] the plugin certain criteria must be met depending on your Operating System, there are 2 guides below, one for windows and other for everything else (which should work on any *nix distro, as well as on OSX).
;Windows
: [[Building HPM Plugin for MSVC]]
;All Others
: [[Building HPM Plugin for gcc]]

= Creating a plugin =
After following the [[#Building_a_plugin|building a plugin]] guide, all thats left is for your plugin's code to be made, the following will guide you through the basics of how a [[HPM]] plugin works.
== HPM Events ==
Events are functions in a plugin that are triggered by the '''Hercules Plugin Mananger''' when they meet certain criteria. 
* <code>void plugin_init (void)</code>
** Triggered when the server starts
* <code>void plugin_final (void)</code>
** Triggered when the server starts to shut itself down
* <code>void server_ready (void)</code>
** Triggered after the server is done starting, and is online.
* <code>void server_post_final (void)</code>
** Triggered after the server's main shutdown procedures are complete, core functionality such as memory manager, timer, and sockets are still available at this point.
With the [[HPM]] you only need to code the events your plugin will use.
== HPM Hooks ==
In Hercules, hooking is a simple operation, it is possible to hook an infinite number of times to the over 2k hookable functions (all the interfaced ones, accounting for over 99% of map server) 
HPExport void plugin_init (void) {
addHookPre("pc->dropitem",my_pc_dropitem_preHook); /* int my_pc_dropitem_preHook(struct map_session_data *sd,int *n,int *amount) */
addHookPost("pc->dropitem",my_pc_dropitem_postHook);/* int my_pc_dropitem_postHook(int retVal, struct map_session_data *sd,int *n,int *amount) */
}
Hooks receive all function params as pointers, whereas the original may be
int pc_dropitem(struct map_session_data *sd,int n,int amount)
the one for the hook shall be
(struct map_session_data *sd,int *n,int *amount)
which allows for hooks to modify any and all data as it pleases. 
postHooks receive one additional param, which accounts for the result of the original function,
int <name>(int retVal, struct map_session_data *sd,int *n,int *amount)
In this case it'd allow for the postHook to react properly to what the original returned, in this case (for pc_dropitem) 0 (failure) or 1 (success) 
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== HPM @commands ==
The [[HPM]] makes it very simple to provide [[@commands]] through plugins. 
You define a new atcommand exactly as it'd normally be done in {{git|src/map/atcommand.c}} 
'''Example:'''
ACMD(sample) {//@sample command - 5 params: const int fd, struct map_session_data* sd, const char* command, const char* message, struct AtCommandInfo *info
clif->message(fd,"You used the @sample command!");
ShowDebug("I'm being run! message -> '%s' by '%s'\n",message,sd->status.name);
return true;
}
After that you just have to link your new command, to do that you use the <code>void plugin_init (void)</code> event.
addAtcommand("sample",sample);
and voila, your plugin now adds the '''@sample''' command. 
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}

As of [https://github.com/HerculesWS/Hercules/commit/778facb21f822cea549939c8dbee886e1cd342aa 778facb21f], atcommands loaded via plugins will overwrite default/original commands with the same name.

== HPM Script Commands ==
The [[HPM]] makes it very simple to provide [[Category:Script_Command|script commands]] through plugins. 
You define a new script command exactly as it'd normally be done in {{git|src/map/script.c}} 
'''Example:'''
BUILDIN(sample) {//script command 'sample(num);' - 1 param: struct script_state* st
int arg = script_getnum(st,2);
ShowInfo("I'm being run! arg -> '%d'\n",arg);
return true;
}
After that you just have to link your new script command, to do that you use the <code>void plugin_init (void)</code> event.
addScriptCommand("sample","i",sample); //note the 2nd param is this commands' arg-types (in this case, a number)
and voila, your plugin now adds the '''sample''' script command. 
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}

== HPM Console Commands ==
The [[HPM]] makes it very simple to provide [[Category:Console_Command|console commands]] through plugins. 
You define a new console command exactly as it'd normally be done in {{git|src/common/console.c}} 
'''Example:'''
CPCMD(sample) {//console command 'sample' - 1 param: char *line
ShowInfo("I'm being run! arg -> '%s'\n",line?line:"NONE");
}
After that you just have to link your new script command, to do that you use the <code>void plugin_init (void)</code> event.
addCPCommand("this:is:a:sample",CPCMD_A(sample)); // note the first param is the path to this command, in this case it translates to 'this is a sample' and everything afterwards is the commands' params
and voila, your plugin now adds the '''sample''' console command. 
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== HPM Custom Packets ==
The HPM makes it possible for a plugin to add or override packets within all 3 servers 
'''Example:'''
/* sample packet implementation */
/* cmd 0xf3 - it is a client-server existent id, for clif_parse_GlobalMessage */
/* in this sample we do nothing and simply redirect */
void sample_packet0f3(int fd) {
struct map_session_data *sd = session[fd]->session_data;

if( !sd ) return;/* socket didn't fully log-in? this packet shouldn't do anything then! */

ShowInfo("sample_packet0f3: Hello World! received 0xf3 for '%s', redirecting!\n",sd->status.name);

clif->pGlobalMessage(fd,sd);
}
void plugin_init(void) {
addPacket(0xf3,-1,sample_packet0f3,hpClif_Parse);
}
and voila, your plugin just changed the map server's '''0xf3''' packet to pass by '''sample_packet0f3''' prior to being sent to '''clif_parse_GlobalMessage''' 
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}

== HPM Custom Data Structs ==
The HPM makes it possible for a plugin to create and append structs to existent data, this feature is currently supported on player units (map_session_data) and network pipes (socket_data) 
'''Example:'''
/* can be of any size, using any data types */
struct sample_data_struct {
struct point lastMSGPosition;
unsigned int someNumber;
};
/* appends/reads sample_data_struct in a network session data entry (socket_data) */
void some_function_receiving_a_socket_fd(int fd) {
struct sample_data_struct *data;

if( !(data = HPMi->getFromSession(session[fd],HPMi->pid,0)) ) {
CREATE(data,struct sample_data_struct,1);

data->lastMSGPosition.map = 1;
data->lastMSGPosition.x = 150;
data->lastMSGPosition.y = 150;
data->someNumber = rand()%777;

ShowInfo("Created Appended session[] data, %d %d %d %d\n",data->lastMSGPosition.map,data->lastMSGPosition.x,data->lastMSGPosition.y,data->someNumber);
HPMi->addToSession(session[fd],data,HPMi->pid,0,true);
} else {
ShowInfo("Existent Appended session[] data, %d %d %d %d\n",data->lastMSGPosition.map,data->lastMSGPosition.x,data->lastMSGPosition.y,data->someNumber);
if( rand()%4 == 2 ) {
ShowInfo("Removing Appended session[] data\n");
HPMi->removeFromSession(session[fd],HPMi->pid,0);
}
}
}
and voila, your plugin becomes capable of appending and handling your custom struct data 
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== HPM Function Overloading ==
Thanks to [[Hercules Renewal Phase One]], you're capable of overloading all functions covered by the [[Hercules Renewal Phase One]] interfaces, with your plugin. 
'''Example:'''
int my_custom_check_target_function( struct block_list *src, struct block_list *target,int flag) {
//<...> code
}
void server_ready(void) {
battle = GET_SYMBOL("battle");
battle->check_target = &my_custom_check_target_function;
}
and voila, your plugin just overloaded the game server's '''battle_check_target''' function with your plugin's own, this is greatly handy to ensure your customs do not create conflicts when updating your [[Hercules|Hercules Repository]]
= Other Features =
Is there something you'd like to do with your plugin that requires modifications to [[HPM]]'s core? [http://hercules.ws/board/forum/55-suggestions/ let we know], and we'll do our best to make it happen. 
[http://hercules.ws/board/forum/55-suggestions/ Post your suggestions here]
= Support =
Need help writing your plugin? [http://hercules.ws/board/forum/26-source-support/ post your question on our support forum]

Hercules Plugin Manager

2013-12-06T07:15:20Z

Sevenzz23: /* HPM Script Commands */

Often referred to as the [[HPM]], the '''Hercules Plugin Manager''' is yet another [[Hercules Original]]
= Building a plugin =
While the [[C]] code for the plugin normally won't have discrepancies, in order to [[compile]] the plugin certain criteria must be met depending on your Operating System, there are 2 guides below, one for windows and other for everything else (which should work on any *nix distro, as well as on OSX).
;Windows
: [[Building HPM Plugin for MSVC]]
;All Others
: [[Building HPM Plugin for gcc]]

= Creating a plugin =
After following the [[#Building_a_plugin|building a plugin]] guide, all thats left is for your plugin's code to be made, the following will guide you through the basics of how a [[HPM]] plugin works.
== HPM Events ==
Events are functions in a plugin that are triggered by the '''Hercules Plugin Mananger''' when they meet certain criteria. 
* <code>void plugin_init (void)</code>
** Triggered when the server starts
* <code>void plugin_final (void)</code>
** Triggered when the server starts to shut itself down
* <code>void server_ready (void)</code>
** Triggered after the server is done starting, and is online.
* <code>void server_post_final (void)</code>
** Triggered after the server's main shutdown procedures are complete, core functionality such as memory manager, timer, and sockets are still available at this point.
With the [[HPM]] you only need to code the events your plugin will use.
== HPM Hooks ==
In Hercules, hooking is a simple operation, it is possible to hook an infinite number of times to the over 2k hookable functions (all the interfaced ones, accounting for over 99% of map server) 
HPExport void plugin_init (void) {
addHookPre("pc->dropitem",my_pc_dropitem_preHook); /* int my_pc_dropitem_preHook(struct map_session_data *sd,int *n,int *amount) */
addHookPost("pc->dropitem",my_pc_dropitem_postHook);/* int my_pc_dropitem_postHook(int retVal, struct map_session_data *sd,int *n,int *amount) */
}
Hooks receive all function params as pointers, whereas the original may be
int pc_dropitem(struct map_session_data *sd,int n,int amount)
the one for the hook shall be
(struct map_session_data *sd,int *n,int *amount)
which allows for hooks to modify any and all data as it pleases. 
postHooks receive one additional param, which accounts for the result of the original function,
int <name>(int retVal, struct map_session_data *sd,int *n,int *amount)
In this case it'd allow for the postHook to react properly to what the original returned, in this case (for pc_dropitem) 0 (failure) or 1 (success) 
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== HPM @commands ==
The [[HPM]] makes it very simple to provide [[@commands]] through plugins. 
You define a new atcommand exactly as it'd normally be done in {{git|src/map/atcommand.c}} 
'''Example:'''
ACMD(sample) {//@sample command - 5 params: const int fd, struct map_session_data* sd, const char* command, const char* message, struct AtCommandInfo *info
clif->message(fd,"You used the @sample command!");
ShowDebug("I'm being run! message -> '%s' by '%s'\n",message,sd->status.name);
return true;
}
After that you just have to link your new command, to do that you use the <code>void plugin_init (void)</code> event.
addAtcommand("sample",sample);
and voila, your plugin now adds the '''@sample''' command. 
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}

As of [https://github.com/HerculesWS/Hercules/commit/778facb21f822cea549939c8dbee886e1cd342aa 778facb21f], atcommands loaded via plugins will overwrite default/original commands with the same name.

== HPM Script Commands ==
The [[HPM]] makes it very simple to provide [[Category:Script_Command|script commands]] through plugins. 
You define a new script command exactly as it'd normally be done in {{git|src/map/script.c}} 
'''Example:'''
BUILDIN(sample) {//script command 'sample(num);' - 1 param: struct script_state* st
int arg = script_getnum(st,2);
ShowInfo("I'm being run! arg -> '%d'\n",arg);
return true;
}
After that you just have to link your new script command, to do that you use the <code>void plugin_init (void)</code> event.
addScriptCommand("sample","i",sample); //note the 2nd param is this commands' arg-types (in this case, a number)
and voila, your plugin now adds the '''sample''' script command. 
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}

== HPM Console Commands ==
The [[HPM]] makes it very simple to provide [[Category:Console_Command|console commands]] through plugins. 
You define a new console command exactly as it'd normally be done in {{git|src/common/console.c}} 
'''Example:'''
CPCMD(sample) {//console command 'sample' - 1 param: char *line
ShowInfo("I'm being run! arg -> '%s'\n",line?line:"NONE");
}
After that you just have to link your new script command, to do that you use the <code>void plugin_init (void)</code> event.
addCPCommand("this:is:a:sample",CPCMD_A(sample)); // note the first param is the path to this command, in this case it translates to 'this is a sample' and everything afterwards is the commands' params
and voila, your plugin now adds the '''sample''' console command. 
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== HPM Custom Packets ==
The HPM makes it possible for a plugin to add or override packets within all 3 servers 
'''Example:'''
/* sample packet implementation */
/* cmd 0xf3 - it is a client-server existent id, for clif_parse_GlobalMessage */
/* in this sample we do nothing and simply redirect */
void sample_packet0f3(int fd) {
struct map_session_data *sd = session[fd]->session_data;

if( !sd ) return;/* socket didn't fully log-in? this packet shouldn't do anything then! */

ShowInfo("sample_packet0f3: Hello World! received 0xf3 for '%s', redirecting!\n",sd->status.name);

clif->pGlobalMessage(fd,sd);
}
void plugin_init(void) {
HPMi->addPacket(0xf3,-1,sample_packet0f3,hpClif_Parse,HPMi->pid);
}
and voila, your plugin just changed the map server's '''0xf3''' packet to pass by '''sample_packet0f3''' prior to being sent to '''clif_parse_GlobalMessage''' 
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== HPM Custom Data Structs ==
The HPM makes it possible for a plugin to create and append structs to existent data, this feature is currently supported on player units (map_session_data) and network pipes (socket_data) 
'''Example:'''
/* can be of any size, using any data types */
struct sample_data_struct {
struct point lastMSGPosition;
unsigned int someNumber;
};
/* appends/reads sample_data_struct in a network session data entry (socket_data) */
void some_function_receiving_a_socket_fd(int fd) {
struct sample_data_struct *data;

if( !(data = HPMi->getFromSession(session[fd],HPMi->pid,0)) ) {
CREATE(data,struct sample_data_struct,1);

data->lastMSGPosition.map = 1;
data->lastMSGPosition.x = 150;
data->lastMSGPosition.y = 150;
data->someNumber = rand()%777;

ShowInfo("Created Appended session[] data, %d %d %d %d\n",data->lastMSGPosition.map,data->lastMSGPosition.x,data->lastMSGPosition.y,data->someNumber);
HPMi->addToSession(session[fd],data,HPMi->pid,0,true);
} else {
ShowInfo("Existent Appended session[] data, %d %d %d %d\n",data->lastMSGPosition.map,data->lastMSGPosition.x,data->lastMSGPosition.y,data->someNumber);
if( rand()%4 == 2 ) {
ShowInfo("Removing Appended session[] data\n");
HPMi->removeFromSession(session[fd],HPMi->pid,0);
}
}
}
and voila, your plugin becomes capable of appending and handling your custom struct data 
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== HPM Function Overloading ==
Thanks to [[Hercules Renewal Phase One]], you're capable of overloading all functions covered by the [[Hercules Renewal Phase One]] interfaces, with your plugin. 
'''Example:'''
int my_custom_check_target_function( struct block_list *src, struct block_list *target,int flag) {
//<...> code
}
void server_ready(void) {
battle = GET_SYMBOL("battle");
battle->check_target = &my_custom_check_target_function;
}
and voila, your plugin just overloaded the game server's '''battle_check_target''' function with your plugin's own, this is greatly handy to ensure your customs do not create conflicts when updating your [[Hercules|Hercules Repository]]
= Other Features =
Is there something you'd like to do with your plugin that requires modifications to [[HPM]]'s core? [http://hercules.ws/board/forum/55-suggestions/ let we know], and we'll do our best to make it happen. 
[http://hercules.ws/board/forum/55-suggestions/ Post your suggestions here]
= Support =
Need help writing your plugin? [http://hercules.ws/board/forum/26-source-support/ post your question on our support forum]

Hercules Plugin Manager

2013-12-06T07:13:45Z

Sevenzz23: /* HPM @commands */

Often referred to as the [[HPM]], the '''Hercules Plugin Manager''' is yet another [[Hercules Original]]
= Building a plugin =
While the [[C]] code for the plugin normally won't have discrepancies, in order to [[compile]] the plugin certain criteria must be met depending on your Operating System, there are 2 guides below, one for windows and other for everything else (which should work on any *nix distro, as well as on OSX).
;Windows
: [[Building HPM Plugin for MSVC]]
;All Others
: [[Building HPM Plugin for gcc]]

= Creating a plugin =
After following the [[#Building_a_plugin|building a plugin]] guide, all thats left is for your plugin's code to be made, the following will guide you through the basics of how a [[HPM]] plugin works.
== HPM Events ==
Events are functions in a plugin that are triggered by the '''Hercules Plugin Mananger''' when they meet certain criteria. 
* <code>void plugin_init (void)</code>
** Triggered when the server starts
* <code>void plugin_final (void)</code>
** Triggered when the server starts to shut itself down
* <code>void server_ready (void)</code>
** Triggered after the server is done starting, and is online.
* <code>void server_post_final (void)</code>
** Triggered after the server's main shutdown procedures are complete, core functionality such as memory manager, timer, and sockets are still available at this point.
With the [[HPM]] you only need to code the events your plugin will use.
== HPM Hooks ==
In Hercules, hooking is a simple operation, it is possible to hook an infinite number of times to the over 2k hookable functions (all the interfaced ones, accounting for over 99% of map server) 
HPExport void plugin_init (void) {
addHookPre("pc->dropitem",my_pc_dropitem_preHook); /* int my_pc_dropitem_preHook(struct map_session_data *sd,int *n,int *amount) */
addHookPost("pc->dropitem",my_pc_dropitem_postHook);/* int my_pc_dropitem_postHook(int retVal, struct map_session_data *sd,int *n,int *amount) */
}
Hooks receive all function params as pointers, whereas the original may be
int pc_dropitem(struct map_session_data *sd,int n,int amount)
the one for the hook shall be
(struct map_session_data *sd,int *n,int *amount)
which allows for hooks to modify any and all data as it pleases. 
postHooks receive one additional param, which accounts for the result of the original function,
int <name>(int retVal, struct map_session_data *sd,int *n,int *amount)
In this case it'd allow for the postHook to react properly to what the original returned, in this case (for pc_dropitem) 0 (failure) or 1 (success) 
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== HPM @commands ==
The [[HPM]] makes it very simple to provide [[@commands]] through plugins. 
You define a new atcommand exactly as it'd normally be done in {{git|src/map/atcommand.c}} 
'''Example:'''
ACMD(sample) {//@sample command - 5 params: const int fd, struct map_session_data* sd, const char* command, const char* message, struct AtCommandInfo *info
clif->message(fd,"You used the @sample command!");
ShowDebug("I'm being run! message -> '%s' by '%s'\n",message,sd->status.name);
return true;
}
After that you just have to link your new command, to do that you use the <code>void plugin_init (void)</code> event.
addAtcommand("sample",sample);
and voila, your plugin now adds the '''@sample''' command. 
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}

As of [https://github.com/HerculesWS/Hercules/commit/778facb21f822cea549939c8dbee886e1cd342aa 778facb21f], atcommands loaded via plugins will overwrite default/original commands with the same name.

== HPM Script Commands ==
The [[HPM]] makes it very simple to provide [[Category:Script_Command|script commands]] through plugins. 
You define a new script command exactly as it'd normally be done in {{git|src/map/script.c}} 
'''Example:'''
BUILDIN(sample) {//script command 'sample(num);' - 1 param: struct script_state* st
int arg = script_getnum(st,2);
ShowInfo("I'm being run! arg -> '%d'\n",arg);
return true;
}
After that you just have to link your new script command, to do that you use the <code>void plugin_init (void)</code> event.
HPMi->addScript("sample","i",BUILDIN_A(sample)); //note the 2nd param is this commands' arg-types (in this case, a number)
and voila, your plugin now adds the '''sample''' script command. 
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== HPM Console Commands ==
The [[HPM]] makes it very simple to provide [[Category:Console_Command|console commands]] through plugins. 
You define a new console command exactly as it'd normally be done in {{git|src/common/console.c}} 
'''Example:'''
CPCMD(sample) {//console command 'sample' - 1 param: char *line
ShowInfo("I'm being run! arg -> '%s'\n",line?line:"NONE");
}
After that you just have to link your new script command, to do that you use the <code>void plugin_init (void)</code> event.
addCPCommand("this:is:a:sample",CPCMD_A(sample)); // note the first param is the path to this command, in this case it translates to 'this is a sample' and everything afterwards is the commands' params
and voila, your plugin now adds the '''sample''' console command. 
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== HPM Custom Packets ==
The HPM makes it possible for a plugin to add or override packets within all 3 servers 
'''Example:'''
/* sample packet implementation */
/* cmd 0xf3 - it is a client-server existent id, for clif_parse_GlobalMessage */
/* in this sample we do nothing and simply redirect */
void sample_packet0f3(int fd) {
struct map_session_data *sd = session[fd]->session_data;

if( !sd ) return;/* socket didn't fully log-in? this packet shouldn't do anything then! */

ShowInfo("sample_packet0f3: Hello World! received 0xf3 for '%s', redirecting!\n",sd->status.name);

clif->pGlobalMessage(fd,sd);
}
void plugin_init(void) {
HPMi->addPacket(0xf3,-1,sample_packet0f3,hpClif_Parse,HPMi->pid);
}
and voila, your plugin just changed the map server's '''0xf3''' packet to pass by '''sample_packet0f3''' prior to being sent to '''clif_parse_GlobalMessage''' 
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== HPM Custom Data Structs ==
The HPM makes it possible for a plugin to create and append structs to existent data, this feature is currently supported on player units (map_session_data) and network pipes (socket_data) 
'''Example:'''
/* can be of any size, using any data types */
struct sample_data_struct {
struct point lastMSGPosition;
unsigned int someNumber;
};
/* appends/reads sample_data_struct in a network session data entry (socket_data) */
void some_function_receiving_a_socket_fd(int fd) {
struct sample_data_struct *data;

if( !(data = HPMi->getFromSession(session[fd],HPMi->pid,0)) ) {
CREATE(data,struct sample_data_struct,1);

data->lastMSGPosition.map = 1;
data->lastMSGPosition.x = 150;
data->lastMSGPosition.y = 150;
data->someNumber = rand()%777;

ShowInfo("Created Appended session[] data, %d %d %d %d\n",data->lastMSGPosition.map,data->lastMSGPosition.x,data->lastMSGPosition.y,data->someNumber);
HPMi->addToSession(session[fd],data,HPMi->pid,0,true);
} else {
ShowInfo("Existent Appended session[] data, %d %d %d %d\n",data->lastMSGPosition.map,data->lastMSGPosition.x,data->lastMSGPosition.y,data->someNumber);
if( rand()%4 == 2 ) {
ShowInfo("Removing Appended session[] data\n");
HPMi->removeFromSession(session[fd],HPMi->pid,0);
}
}
}
and voila, your plugin becomes capable of appending and handling your custom struct data 
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== HPM Function Overloading ==
Thanks to [[Hercules Renewal Phase One]], you're capable of overloading all functions covered by the [[Hercules Renewal Phase One]] interfaces, with your plugin. 
'''Example:'''
int my_custom_check_target_function( struct block_list *src, struct block_list *target,int flag) {
//<...> code
}
void server_ready(void) {
battle = GET_SYMBOL("battle");
battle->check_target = &my_custom_check_target_function;
}
and voila, your plugin just overloaded the game server's '''battle_check_target''' function with your plugin's own, this is greatly handy to ensure your customs do not create conflicts when updating your [[Hercules|Hercules Repository]]
= Other Features =
Is there something you'd like to do with your plugin that requires modifications to [[HPM]]'s core? [http://hercules.ws/board/forum/55-suggestions/ let we know], and we'll do our best to make it happen. 
[http://hercules.ws/board/forum/55-suggestions/ Post your suggestions here]
= Support =
Need help writing your plugin? [http://hercules.ws/board/forum/26-source-support/ post your question on our support forum]

Hercules Original

2013-12-06T06:18:19Z

Sevenzz23:

List of [[Hercules Original|Original Hercules Features]]
* '''[New]'''[http://hercules.ws/board/topic/2954-item-db-file-structure-overhaul/ Item DB File Structure Overhaul]
* [http://hercules.ws/board/topic/302-introducing-hercules-map-zone-database/ Hercules Map Zone DB]
* [[HPM|Hercules Plugin Mananger]]
* [http://hercules.ws/board/topic/316-introducing-hercules-channel-system/ Hercules Channel System]
* [http://hercules.ws/board/topic/353-packetdb-overhaul/ Packet DB Overhaul]
* [http://hercules.ws/board/topic/548-hercules-console-input-update/ Console Input Redesign]
[[Category:Hercules]]

Adding a Script

2013-12-06T04:19:07Z

Sevenzz23: /* Lua */

== Adding and Activating Scripts ==
Scripts are usually kept in the ''npc'' folder for the sake of organization even though scripts can contain more than a mere NPC. All files are saved as text files. Scripts cannot be loaded on to the server unless their text file is activated in a *.conf file.

=== A New Script ===
New scripts must be saved as a text file first. The file may be located anywhere in the Hercules directory, but is in the ''npc'' folder by default.

=== Configuration Files ===
Any text editor may be used to edit *.conf files. The ''npc/*.conf'' files are used to determine which script text files should be loaded. There are about a dozen *.conf that handle different groups of scripts for the purpose of organization. It does not matter which *.conf holds your custom scripts as long as the path is correct.

Typical *.conf entry layout:
npc: npc/path/to/yourscript1.txt
// npc: npc/path/to/yourscript2.txt
Note how the second line is preceded with a double slash. Content on the same line after double slashes will not be parsed. In other words, ''script2.txt'' will not be loaded. The slashes can be used to write comments.

{{git|npc/scripts_main.conf}} determines which of the *.conf will be read by the server.
import: npc/path/to/configuration.conf

=== The NPC in Game ===
After adding the script, it must be loaded before the script contents take effect in game. There are a few ways to do this.
* The map server can be rebooted. This is generally the safest route though not the most convenient for active servers.
* The GM command '''@reloadscript''' maybe used in game, though this may cause monster spawn bugs.
* If a script needs to be reloaded because it has been edited, the GM commands '''@loadnpc''' and '''@unloadnpc''' may be used. This method is not convenient for script texts that contain multiple NPCs.

== Client Side ==
The NPC name used in examples is "Teddy".
===Lua===
The two files you will need to open and edit are "jobname.lua" and "npcidentity.lua". Jobname.lua will look like:

[jobtbl.NPCNAME] = "NPCNAME",
Example:
[jobtbl.TEDDY] = "TEDDY",
npcidentity.lua will look like:
["NPCNAME"] = NPCID,
Example:
["TEDDY"] = 587,
If your NPC has spaces in its name, its best to either remove them or replace them with underscores. So if the NPC's name was Brown Teddy the sprite's name would be Brown_Teddy.spr or BrownTeddy.spr and the lua files would be BROWN_TEDDY or BROWNTEDDY. Whatever ID you choose for your sprite neither NPC's name or ID will be use in the script. The beginning of my script will look like:

xmas_in,111,107,3 script Teddy 587,{
xmas_in,111,107,3 script Teddy TEDDY,{

===Sprite===
The sprite part is straightforward, just Teddy.spr is fine, you don't need Teddy_m.spr or anything like that, but if you want to add m for male to the name you can do that, but it won't effect its functionality in-game. NPC sprites are located in data/sprite/npc.

== Tips & Hints ==
* If you are copy/pasting a script from a forum, be sure to check that the tabs are still intact.
* Remember that paths and file names are case sensitive.
* Remember to save after editing.
* Create your own NPC folder and *.conf file. This will make it much easier to keep track of your own scripts and can reduce the hassle when merging new revisions of rA. Follow the basic layout of the other *.conf files and remember to import the *.conf in {{git|npc/scripts_main.conf}}

[[Category:Scripting]]

Autobonus

2013-12-05T12:46:27Z

Sevenzz23:

== Syntax ==
* [[autobonus]] <bonus script>,<rate>,<duration>{,<flag>,{<other script>}};
* autobonus2 <bonus script>,<rate>,<duration>{,<flag>,{<other script>}};
* autobonus3 <bonus script>,<rate>,<duration>,<skill id>,{<other script>};
* autobonus3 <bonus script>,<rate>,<duration>,"<skill name>",{<other script>};
== Description ==
These commands are meant to be used in item scripts. They will probably
work outside item scripts, but the bonus will not persist for long. They,
as expected, refer only to an invoking character.

What these commands do is '''attach''' a script to the player which will get
executed on attack (or when attacked in the case of autobonus2).

Rate is the trigger rate of the script (10000 = 100%).

Duration is the time that the bonus will last for since the script has
triggered.

Skill ID/skill name the skill which will be used as trigger to start the
bonus (for autobonus3).

The optional argument 'flag' is used to classify the type of attack where
the script can trigger (it shares the same flags as the bAutoSpell bonus
script):

Range criteria:
BF_SHORT: Trigger on melee attack
BF_LONG: Trigger on ranged attack
Default: BF_SHORT+BF_LONG
Attack type criteria:
BF_WEAPON: Trigger on weapon skills
BF_MAGIC: Trigger on magic skills
BF_MISC: Trigger on misc skills
Default: BF_WEAPON
Skill criteria:
BF_NORMAL: Trigger on normal attacks
BF_SKILL: Trigger on skills
default: If the attack type is BF_WEAPON (only) BF_NORMAL is used,
otherwise BF_SKILL+BF_NORMAL is used.

The difference between the optional argument '''other script''' and the '''bonus
script''' is that, the former one triggers only when attacking (or attacked)
and the latter one runs on status calculation as well, which makes sure,
within the duration, the ''bonus''that get lost on status calculation is
restored. So, '''bonus script''' is technically supposed to accept ''bonus''
command only. And we usually use '''other script''' to show visual effects.

:In all cases, when the script triggers, the attached player will be the
:one who holds the bonus. There is currently no way of knowing within this
:script who was the other character (the attacker in autobonus2, or the
:target in autobonus and autobonus3).

== Example ==
//Grants a 1% chance of starting the state "all stats +10" for 10 seconds
//when using weapon or misc attacks (both melee and ranged skills) and
//shows a special effect when the bonus is active.
autobonus "{ bonus bAllStats,10; }",10,10000,BF_WEAPON|BF_MISC,"{ specialeffect2 EF_FIRESPLASHHIT; }";

[[Category:Script Commands]]

Autobonus

2013-12-05T12:44:58Z

Sevenzz23: Created page with "== Syntax == *autobonus <bonus script>,<rate>,<duration>{,<flag>,{<other script>}}; *autobonus2 <bonus script>,<rate>,<duration>{,<flag>,{<other script>}}; *autobonus3 <bonus ..."

== Syntax ==
*autobonus <bonus script>,<rate>,<duration>{,<flag>,{<other script>}};
*autobonus2 <bonus script>,<rate>,<duration>{,<flag>,{<other script>}};
*autobonus3 <bonus script>,<rate>,<duration>,<skill id>,{<other script>};
*autobonus3 <bonus script>,<rate>,<duration>,"<skill name>",{<other script>};
== Description ==
These commands are meant to be used in item scripts. They will probably
work outside item scripts, but the bonus will not persist for long. They,
as expected, refer only to an invoking character.

What these commands do is '''attach''' a script to the player which will get
executed on attack (or when attacked in the case of autobonus2).

Rate is the trigger rate of the script (10000 = 100%).

Duration is the time that the bonus will last for since the script has
triggered.

Skill ID/skill name the skill which will be used as trigger to start the
bonus (for autobonus3).

The optional argument 'flag' is used to classify the type of attack where
the script can trigger (it shares the same flags as the bAutoSpell bonus
script):

Range criteria:
BF_SHORT: Trigger on melee attack
BF_LONG: Trigger on ranged attack
Default: BF_SHORT+BF_LONG
Attack type criteria:
BF_WEAPON: Trigger on weapon skills
BF_MAGIC: Trigger on magic skills
BF_MISC: Trigger on misc skills
Default: BF_WEAPON
Skill criteria:
BF_NORMAL: Trigger on normal attacks
BF_SKILL: Trigger on skills
default: If the attack type is BF_WEAPON (only) BF_NORMAL is used,
otherwise BF_SKILL+BF_NORMAL is used.

The difference between the optional argument '''other script''' and the '''bonus
script''' is that, the former one triggers only when attacking (or attacked)
and the latter one runs on status calculation as well, which makes sure,
within the duration, the ''bonus''that get lost on status calculation is
restored. So, '''bonus script''' is technically supposed to accept ''bonus''
command only. And we usually use '''other script''' to show visual effects.

:In all cases, when the script triggers, the attached player will be the
:one who holds the bonus. There is currently no way of knowing within this
:script who was the other character (the attacker in autobonus2, or the
:target in autobonus and autobonus3).

== Example ==
//Grants a 1% chance of starting the state "all stats +10" for 10 seconds
//when using weapon or misc attacks (both melee and ranged skills) and
//shows a special effect when the bonus is active.
autobonus "{ bonus bAllStats,10; }",10,10000,BF_WEAPON|BF_MISC,"{ specialeffect2 EF_FIRESPLASHHIT; }";

[[Category:Script Commands]]

Compiling/Windows

2013-12-05T05:54:02Z

Sevenzz23: /* Using Visual Studio */

For compiling on Windows, Visual Studio is the preferred method, although using Cygwin is also possible.

=== Using Visual Studio ===
[[Image:Compile-hercules.PNG|thumb|300px|MS Visual Studio 2010: Compile configuration (red) and solution (blue) with it's child projects.]]
Hercules ships with solution and project files for Visual Studio from 9 onwards. Usage of both the paid and free (express) versions is same, although the paid one produces more efficient code [http://nn.nachtwolke.com/dev/ref/msvcperf.htm].
* Download [http://www.microsoft.com/visualstudio/en-us/products/2010-editions/visual-cpp-express MS Visual C++ 2010 Express Edition],[http://www.microsoft.com/visualstudio/en-us/products/2008-editions/express MS Visual C++ 2008 Express Edition], MS Visual Studio 2012 or MS Visual Studio 2013 and install it, if you do not have Visual Studio/Visual C++ already installed.
* Open '''Hercules-10.sln''' in your Hercules folder if you use Visual C++ 2010, for Visual C++ 2008, you need to open '''Hercules-9.sln''', for Visual Studio 2012, you need to open '''Hercules-11.sln''', If you use Visual Studio 2013, you need to open '''Hercules-12.sln''' instead.
* Select the desired compile configuration (marked red). Use '''Release''' when you compile the server, where players will be playing on. '''Debug''' compiles the server without optimizations and with debugging information.
* Right-click the solution node (marked blue) and select '''Build solution'''. If you have compiled the server before, it is recommended to use '''Rebuild solution''', as it forces the compiling of all components, not just those, which seem to have changed since last compile.
* If the compilation was successful, the resulting executables are in the same folder as the solution named ''login-server.exe'', ''char-server.exe'', ''map-server.exe'' and ''mapcache.exe''.

=== Using Cygwin ===
[http://www.cygwin.com/ Cygwin] is a Linux environment emulation for Windows. As such it enables compiling the way it would be done on Linux. Compiling in Cygwin is '''not recommended''' due to lower performance and increased installation complexity.

* Download [http://www.cygwin.com/setup.exe Cygwin] and install it, if not already done so. When installing, select following packages:
** from ''Devel'': ''cmake'', ''gcc'' and ''make''
** from ''Lib'': ''libidn-devel'', ''libpcre-devel'', ''readline'', ''zlib-devel''
* Running Cygwin Terminal will create folder <code>'''home/user'''</code> inside Cygwin installation folder, where ''user'' is the name currently logged on Windows user.
* SQL server needs to be installed in Cygwin so the compiler can access the SQL libraries. Download the .tar.gz archive from the [http://dev.mysql.com/downloads/mysql/?current_os=src MySQL website], such as '''mysql-5.5.20.tar.gz'''.
* Place the archive into <code>'''/home/user'''</code> and execute following inside Cygwin Terminal to unpack it:
cd ~
tar xvzf mysql-5.5.20.tar.gz
* Navigate to directory with unpacked archive:
cd mysql-5.5.20
* To avoid conficts, replace ''dtoa()'' with ''_dtoa()'' in ''strings/dtoa.c'' file:
sed -i 's/dtoa(/_dtoa(/g' ./strings/dtoa.c
* Build MySQL with following commands:
cmake .
make mysqlclient libmysql
make install
* After everything completes, Cygwin is ready for compiling Hercules. Navigate to the Hercules folder in Cygwin. Windows drives are accesible as <code>/cygdrive/x</code> where ''x'' is the letter assigned to the drive by Windows.
* Execute following commands inside Hercules folder to compile it:
./configure --with-mysql=/usr/local/mysql/bin/mysql_config
make sql
* If the compilation was successful, the resulting executables are in the Hercules folder named ''login-server_sql.exe'', ''char-server_sql.exe'' and ''map-server_sql.exe''.
* Server executables can be run inside Cygwin Terminal or directly, but in this case you need to copy required libraries to Hercules folder:
** ''cygwin1.dll'', ''cygz.dll'', ''cyggcc_s-1.dll'', ''cygpcre-0.dll'' from <code>/bin</code>
** ''cygmysqlclient-18.dll'' from <code>/usr/local/mysql/lib</code>

Getitem

2013-12-05T04:36:58Z

Sevenzz23:

[[Category:Script_Command]]
==Syntax==
* [[getitem]] <item id>,<amount>{,<account ID>};
* [[getitem]] "<item name>",<amount>{,<account ID>};
==Description==
This command will give a specific amount of specified items to the target
character. If the character is not online, nothing will happen.
If <character ID> is not specified, items will be created in the invoking
character inventory instead.

In the first and most commonly used version of this command, items are
referred to by their database ID number, which can be found in {{git|db/pre-re/item_db.txt}} or {{git|db/re/item_db.txt}}

Giving an item ID of -1 will give a specified number of random items from the
list of those that fall out of Old Blue Box. Unlike in all other cases, these
will be unidentified, if they turn out to be equipment. This is exactly what's
written in the Old Blue Box's item script.

Other negative IDs also correspond to other random item generating item tables:

Giving an item ID of -2 will produce the effects of Old Violet Box.
Giving an item ID of -3 will produce the effects of Old Card Album.
Giving an item ID of -4 will produce the effects of Gift Box.
Giving an item ID of -5 will produce the effects of Worn Out Scroll, which drops only Jellopies anyway.

This transaction is logged if the log script generated transactions option is
enabled.

You may also create an item by it's name in the 'english name' field in the
item database:

Which will do what you'd expect. If it can't find that name in the database,
apples will be created anyway. It is often a VERY GOOD IDEA to use it like this.

This is used in pretty much all NPC scripts that have to do with items and
quite a few item scripts. For more examples check just about any official script.

==Examples==
<pre>
getitem 502,10; // The person will receive 10 apples
getitem 617,1; // The person will receive 1 Old Violet Box
getitem "RED_POTION",10;
</pre>
== See Also ==
* [[getitem2]]

[[Category:Script Command]]

Getitem2

2013-12-05T04:33:51Z

Sevenzz23:

== Syntax ==
* [[getitem2]] <item id>,<amount>,<identify>,<refine>,<attribute>,<card1>,<card2>,<card3>,<card4>{,<account ID>};
* [[getitem2]] "<item name>",<amount>,<identify>,<refine>,<attribute>,<card1>,<card2>,<card3>,<card4>{,<account ID>};
==Description==
This command will give an amount of specified items to the invoking
character. If an optional account ID is specified, and the target
character is currently online, items will be created in their inventory
instead. If they are not online, nothing will happen. It works essentially
the same as [[getitem]] (it even works for negative ID numbers the same way)
but is a lot more flexible.

Those parameters that are different from [[getitem]] are:

identify - Whether you want the item to be identified (1) or not (0).
refine - For how many pluses will it be refined. It will not let you
refine an item higher than the max refine.
attribute - Whether the item is broken (1) or not (0).
card1,2,3,4 - If you want a card compound to it, place the card ID number
into the specific card slot.

Card1-card4 values are also used to store name information for named
items, as well as the elemental property of weapons and armor. You can
create a named item in this manner, however, if you just need a named
piece of standard equipment, it is much easier to the [[getnameditem]]
function instead.

You will need to keep these values if you want to destroy and then
perfectly recreate a named item, for this see [[getinventorylist]].

If you still want to try creating a named item with this command because
[[getnameditem]] won't do it for you cause it's too limited, you can do it
like this. Careful, minor magic ahead.
==Examples==
// First, let's get an ID of a character who's name will be on the
// item. Only an existing character's name may be there.
// Let's assume our character is 'Adam' and find his ID.

set @charid,getcharid(0,"Adam");

// Now we split the character ID number into two portions with a
// binary shift operation. If you don't understand what this does,
// just copy it.

set @card3, @charid & 65535;
set @card4, @charid >> 16;

// If you're inscribing non-equipment, @card1 must be 254.
// Arrows are also not equipment. :)
set @card1,254;

// For named equipment, card2 means the Star Crumbs and elemental
// crystals used to make this equipment. For everything else, it's 0.

set @card2,0;

// Now, let's give the character who invoked the script some
// Adam's Apples:

getitem2 512,1,1,0,0,@card1,@card2,@card3,@card4;

==Description continue...==
This wasn't tested with all possible items, so I can't give any promises,
experiment first before relying on it.

To create equipment, continue this example it like this:
==Examples continue...==
// We've already have card3 and card4 loaded with correct
// values so we'll just set up card1 and card2 with data
// for an Ice Stiletto.

// If you're inscribing equipment, @card1 must be 255.
set @card1,255;

// That's the number of star crumbs in a weapon.
set @sc,2;

// That's the number of elemental property of the weapon.
set @ele,1;

// And that's the wacky formula that makes them into
// a single number.
set @card2,@ele+((@sc*5)<<8);

// That will make us an Adam's +2 VVS Ice Stiletto:

getitem2 1216,1,1,2,0,@card1,@card2,@card3,@card4;

Experiment with the number of star crumbs - I'm not certain just how much
will work most and what it depends on. The valid element numbers are:

1 - Ice, 2 - Earth 3 - Fire 4 - Wind.

You can, apparently, even create duplicates of the same pet egg with this
command, creating a pet which is the same, but simultaneously exists in
two eggs, and may hatch from either, although, I'm not sure what kind of a
mess will this really cause.
== See Also ==
* [[getitem]]

[[Category:Script_Command]]

Getitembound

2013-12-05T04:31:25Z

Sevenzz23:

== Syntax ==
* [[getitembound]] <item id>,<amount>,<bound type>{,<account ID>};
* [[getitembound]] "<item name>",<amount>,<bound type>{,<account ID>};
== Description ==
These commands will create bounded items.

This command behaves identically to [[getitem]], but the items created will be
bound to the target character as specified by the bound type. All items created
in this manner cannot be dropped, sold, vended, auctioned, or mailed, and in
some cases cannot be traded or stored.

Valid bound types are:
0 - Regular [[getitem]]
1 - Account Bound
2 - Guild Bound
3 - Party Bound
4 - Character Bound

Default is 0 if not defined.
== Example ==
getitembound 2220,1,1; // The person will receive 1 Account bounded Hat that can store in storage.
getitembound 2226,1,2; // The person will receive 1 Guild Bound Cap that can share and store in Guild Storage.
getitembound "Crown",1,4; // The person will receive 1 Char Bound Crown that cannot store sell or drop.
== See Also ==
* [[getitembound2]]
* [[countbound]]

[[Category:Script Command]]

Getitembound2

2013-12-05T04:31:12Z

Sevenzz23:

== Syntax ==
* [[getitembound2]] <item id>,<amount>,<identify>,<refine>,<attribute>,<card1>,<card2>,<card3>,<card4>,<bound type>;
* [[getitembound2]] "<item name>",<amount>,<identify>,<refine>,<attribute>,<card1>,<card2>,<card3>,<card4>,<bound type>;

== Description ==
This command behaves identically to [[getitem2]], but the items created will be
bound to the target character as specified by the bound type. All items created
in this manner cannot be dropped, sold, vended, auctioned, or mailed, and in
some cases cannot be traded or stored.

For a list of bound types see [[getitembound]].

Default is 0 if not defined.
== Example ==
getitembound2 1602,1,1,2,0,4004,4004,4004,4004,1; // The person will receive 1 Account bounded "Rod with 4 Drops card" on it.

See example script in npc/costum/itembind.txt
== See Also ==
* [[getitembound]]
* [[countbound]]

[[Category:Script Command]]

Countbound

2013-12-05T04:30:33Z

Sevenzz23: /* See Also */

== Syntax ==
* [[countbound]] ({<bound type>})

== Description ==
This function will return the number of bounded items in the character's
inventory, and sets an array @bound_items[] containing all item IDs of the
counted items. If a bound type is specified, only those items will be counted.

For a list of bound types see [[getitembound]].
== Example==
Example:
mes "You currently have "+countbound()+" bounded items.";
next;
mes "The list of bounded items include:";
for(set .@i,0; .@i<getarraysize(@bound_items); set .@i,.@i+1)
mes getitemname(@bound_items[.@i]);
close;
== See Also ==
* [[getitembound]]
* [[getitembound2]]

[[Category:Script Command]]

Countbound

2013-12-05T04:30:06Z

Sevenzz23:

Getitembound2

2013-12-05T04:28:13Z

Sevenzz23:

Getitembound

2013-12-05T04:17:44Z

Sevenzz23: