eAthena Support

RO Script Commands

Script Commands

This guide contains script commands. I took them out from the script.txt from the SCR folder in eAthena.
It is not finished yet nor sorted and some discriptions of the commands are missing, but I hope you like it.



If you have a eAthena Server, then you should look into your DOC folder.
There you'll find very useful documents.
example:   - effect_list
                  - script_commands
                  - itembonus
                  - and many more

Some Commands have been made by:

  - Celest
  - Skotlex
  - RoVeRT
  - Valaris
  - MouseJstr
  - Lorky [Lupus]
  - Spectre
  - Lance
  - Qamera
  - orn
  - Zephyrus
  - Lordalfa
  - LuzZza
  - Fredzilla
  - and other people


mes:
 * This command will displays a box on the screen for the invoking character.
 * Usuage:  mes "<message>";


next:
 * Displays the button 'next' in the npc dialog.
 * The dialog text is cleared and the script continues when the button is pressed.
 * Usuage: next;


close: 
 * Ends the script and displays the button 'close' on the npc dialog.
 * The dialog is closed when the button is pressed.
 * Usuage: close;


close2: 
 * Displays the button 'close' on the npc dialog.
 * The dialog is closed and the script continues when the button is pressed.
 * Usuage: close2;


menu:  
 * Displays a menu with options and goes to the target label.
 * NOTE: the client closes the npc dialog when cancel is pressed
 * Usuage: menu "<option_text>",<target_label>{,"<option_text>",<target_label>,...};


select:      
 * Displays a menu with options and returns the selected option.
 * Behaves like 'menu' without the target labels.
 * Usuage: select(<option_text>{,<option_text>,...}) -> <selected_option>;


prompt:  
 * Displays a menu with options and returns the selected option.
 * Behaves like 'menu' without the target labels, except when cancel is pressed.
 * When cancel is pressed, the script continues and 255 is returned.
 * Usuage: prompt("<option>"{,"<option>",...})


goto:  
 * Jumps to the target script label.
 * Usuage: goto <label>;


callfunc: 
 * This command lets you calls up a function NPC. A function NPC can
 * be called from any script on any map server.
 * Usuage: callfunc "<function>"{,<argument>,...<argument>};


callsub:
 * This command will go to a specified label within the current script.
 * Works like "callfunc" but DO NOT use QUOTES.
 * Usuage: callsub <label>{,<argument>,...<argument>};


getarg:  
 * This function is used when you use the "callsub" or "callfunc" commands.
 * Usuage: getarg(<index>{,<default_value>})


return:  
 * Returns from the current function, optionaly returning a value from the functions.
 * Don't use outside script functions.
 * Usuage: return;
           return <value>;


rand:  
 * Returns a random number from 0 to <range>-1.
 * Or returns a random number from <min> to <max>.
 * If <min> is greater than <max>, their numbers are switched.
 * Usuage: rand(<range>);
           rand(<min>,<max>);


warp:
 * This command will warp the character to a specfic map.
 * Usuage: warp "<map name>",<x>,<y>;


areawarp:
 * This command is similar to "warp" but it warps all players in the map.
 * Everyone that is the area between X1,Y1 and X2,Y2 will be warped.
 * Usuage: areawarp "<from map name>",<x1>,<y1>,<x2>,<y2>,"<to map name>",<x3>,<y3>;


 warpchar:  
  * Useful for warp one player from another player npc-session.
  * Usuage: warpchar "mapname",x,y,Char_ID;


warpparty:   
  * Warps a party to a specific map.
  * Usuage: warpparty "mapname",x,y,Party_ID;


warpguild:  
 * Warps a Guild to a specific map.
 * Usuage: warpguild "mapname",x,y,Guild_ID;

I am going to update it daily