Basic Scripting - Revision history

Wolfeh: Removed any references to NPC ID's. These are no longer recommended and may lose support.

2016-09-17T22:17:46Z

Removed any references to NPC ID's. These are no longer recommended and may lose support.

Haru: Severely outdated syntax

2016-09-16T18:47:38Z

Severely outdated syntax

HerculesWikiEditor: <replacetext_editsummary>

2016-04-25T12:51:10Z

<replacetext_editsummary>

HerculesWikiEditor: <replacetext_editsummary>

2016-04-25T12:45:42Z

<replacetext_editsummary>

Via: /* NPC */ Formatting. o-o

2014-01-28T20:22:24Z

‎NPC: Formatting. o-o

Via: /* NPC */ Misinformation. :<

2014-01-28T20:20:53Z

‎NPC: Misinformation. :<

Ind at 06:24, 14 January 2013

2013-01-14T06:24:40Z

Mysterious at 04:15, 13 January 2013

2013-01-13T04:15:43Z

Mysterious at 04:14, 13 January 2013

2013-01-13T04:14:08Z

Mysterious at 04:13, 13 January 2013

2013-01-13T04:13:50Z

@@ Line 13: / Line 13: @@
 ===NPC===
 A '''Script NPC''' will look something like the following:
-  prontera,156,145,4 <tab> script <tab> Test NPC <tab> 58,{
+  prontera,156,145,4 <tab> script <tab> Test NPC <tab> 1_M_MERCHANT,{
 The first section is the map location of the NPC, followed by its coordinates in x,y and the direction the NPC will face.  Direction numbers are counted counterclockwise in 45º increments, with 0 being the center: <br>
@@ Line 33: / Line 33: @@
 ===Shop===
 A '''Shop''' starts like a normal script:
-  prontera,156,145,4 <tab> shop <tab> Fruit Store <tab> 58,512:-1,513:1000
+  prontera,156,145,4 <tab> shop <tab> Fruit Store <tab> 1_M_MERCHANT,512:-1,513:1000
 The first section defines the map, coordinates, and direction.  The word "shop" replaces "script" (alternately, "cashshop" will use Cashpoints instead of Zeny).  The name and sprite ID follow, then a comma. <br>
@@ Line 143: / Line 143: @@
 Take a look at our old Test NPC:
-  prontera,156,145,4 <tab> script <tab> Test NPC <tab> 58,{
+  prontera,156,145,4 <tab> script <tab> Test NPC <tab> 1_M_MERCHANT,{
 To be able to duplicate this, we will change the heading to this:
-  - <tab> script <tab> Test NPC#01::testnpc <tab> 58,{
+  - <tab> script <tab> Test NPC#01::testnpc <tab> 1_M_MERCHANT,{
 The location doesn't need to be defined in the NPC, since it will be in the duplicates. <br>
 The displayed name remains "Test NPC".  But since NPC names must be unique, adding #01 separates this one from the rest, which will be #02, #03, etc.  Lastly, ::testnpc is the reference name used for duplicating NPCs; this part is not displayed on the screen. <br>
 After creating the base NPC, duplicates can be added anywhere to any file, so long as you use the same NPC name:
-  spl_fild03,150,150,7 <tab> duplicate(testnpc) <tab> Test NPC <tab> 58
+  spl_fild03,150,150,7 <tab> duplicate(testnpc) <tab> Test NPC <tab> 1_M_MERCHANT
-  niflheim,50,50,2 <tab> duplicate(testnpc) <tab> Test NPC <tab> 58
+  niflheim,50,50,2 <tab> duplicate(testnpc) <tab> Test NPC <tab> 1_M_MERCHANT
-  tha_scene01,140,190,4 <tab> duplicate(testnpc) <tab> Test NPC <tab> 58
+  tha_scene01,140,190,4 <tab> duplicate(testnpc) <tab> Test NPC <tab> 1_M_MERCHANT
 The first part is ''map,x,y,direction'', as you're probably used to by now. <br>
-To define a duplicate, the word "duplicate" followed by the NPC, in parentheses, is needed.  The last two parameters are the display name and sprite ID (yes, you can change these, too!).
+To define a duplicate, the word "duplicate" followed by the NPC, in parentheses, is needed.  The last two parameters are the display name and NPC view constant (actual name of the npc sprite, yes, you can change these, too!).
 ==Finished Product==
@@ Line 160: / Line 160: @@
 Here is an example using the features explained above:
-  prontera,156,145,4	script	Test NPC::test	589,{
+  prontera,156,145,4	script	Test NPC::test	4_WHIKEBAIN,{
       mes "Hello, how are you?";
       mes "I am fine, how are you?";
@@ Line 189: / Line 189: @@
+  }
-  lhz_dun01,157,285,4	duplicate(test)	Test NPC	859
+  lhz_dun01,157,285,4	duplicate(test)	Test NPC	4_F_AGENTKAFRA
-  hu_fild05,186,210,4	duplicate(test)	Test NPC	859
+  hu_fild05,186,210,4	duplicate(test)	Test NPC	4_F_AGENTKAFRA
-  yuno_fild07,221,179,4	duplicate(test)	Test NPC	859
+  yuno_fild07,221,179,4	duplicate(test)	Test NPC	4_F_AGENTKAFRA
-  tha_scene01,139,194,1	duplicate(test)	Test NPC	859
+  tha_scene01,139,194,1	duplicate(test)	Test NPC	4_F_AGENTKAFRA
 ==Adding Scripts==

← Older revision		Revision as of 18:47, 16 September 2016
Line 1:		Line 1:
		+	{{outdated}}
		+
	==The Basics==		==The Basics==

@@ Line 21: / Line 21: @@
 After the first tab, the type of script is defined.  For our purposes, it'll stay "script" for now, but can also be function, shop, or cashshop, for starters. <br>
 The name of the NPC is next.  You can use up to 24 characters, so make it unique!  Any duplicates will cause warnings or errors, and the NPC will just be automatically renamed anyway. <br>
-The last number is for the sprite (Ai4rei's sprite list can be found [http://nn.nachtwolke.com/dev/npclist/ here]).  It's followed by a comma and open curly bracket, marking the beginning of the script contents.  Of course, the script must also end in a curly bracket.<br>
+The last number is for the sprite (Ai4rei's sprite list can be found [http://nn.ai4rei.net/dev/npclist/ here]).  It's followed by a comma and open curly bracket, marking the beginning of the script contents.  Of course, the script must also end in a curly bracket.<br>
 ===Function===
@@ Line 204: / Line 204: @@
 '''Sprite lists'''
-* http://nn.nachtwolke.com/dev/npclist/
+* http://nn.ai4rei.net/dev/npclist/
 '''Color Charts'''

@@ Line 213: / Line 213: @@
 '''Support, Request and Release'''
-* [http://hercules.ws/board/forum/22-script-support/ Scripting support on Hercules Boards]
+* [http://herc.ws/board/forum/22-script-support/ Scripting support on Hercules Boards]
 * #Hercules on irc.rizon.net : Main Hercules channel.
 [[Category:Scripting]]

@@ Line 16: / Line 16: @@
 [1][0][7] <br>
-[2]   [6] <br>
+[2][&nbsp;&nbsp;][6] <br>
 [3][4][5] <br>

@@ Line 3: / Line 3: @@
 Scripts control all NPCs, warps, mob spawns, shops, and quests you will find in the game--and nearly everything else!  Clearly they play a large part in customizing a server, but learning isn't very hard.
-Scripts are built up of predefined script commands, all of which can be found in {{git|/doc/script_commands.txt}} (for explanations, see [[:Category:Script_Command|Script Commands]]).  Every line should begin with a command and the argument it takes, and must end in a semicolon (or you'll get mapserver errors!).  Arguments are usually separated by commas, and are sometimes contained in parentheses () or curly brackets {}.  Tabs and proper indentation are standard scripting measures.
+Scripts are built up of predefined script commands, all of which can be found in {{git|doc/script_commands.txt}} (for explanations, see [[:Category:Script_Command|Script Commands]]).  Every line should begin with a command and the argument it takes, and must end in a semicolon (or you'll get mapserver errors!).  Arguments are usually separated by commas, and are sometimes contained in parentheses () or curly brackets {}.  Tabs and proper indentation are standard scripting measures.
 Scripts are saved as text (*.txt) files, so all code can be written in Notepad.  There are also a lot of scripting programs to use: the most recent and comprehensive one is [http://rathena.org/board/topic/56484-enpc-script-editor/ Vince's eNPC]. All defined functions are highlighted, with an autocomplete feature included, and pressing "F1" will display the corresponding explanation for any command.

@@ Line 201: / Line 201: @@
 ==External Links==
 '''Reference Manuals for scriping commands'''
-* {{svn|trunk/doc/script_commands.txt}} Original documentation
+* {{git|/doc/script_commands.txt}} Original documentation
 '''Sprite lists'''