Mirroristas/rathena
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

* Added missing bindatcmd documentation (tid:74882).

Browse Source 
* Follow-up r16976: spell check and other minor changes.

git-svn-id: https://svn.code.sf.net/p/rathena/svn/trunk@16978 54d463be-8e91-2dee-dedb-b68131a5f0ec
This commit is contained in:
euphyy 2012-11-29 01:34:17 +00:00
parent 60b1b0bc97
commit a0b84ee722
2 changed files with 61 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

104
README.txt
View File

@ -1,19 +1,19 @@
//============================================================ //============================================================
//= rAthena ReadMe File //= rAthena Readme File
//===== By: ================================================== //===== By: ==================================================
//= rAthena Development Team //= rAthena Dev Team
//===== Compatible With: ===================================== //===== Current Version: =====================================
//= rAthena SVN //= 20121128
//===== Description: ========================================= //===== Description: =========================================
//= Basic information and installation guide with links to //= Basic information and installation guide with links to
//= various forum posts and wiki articles. //= various forum posts and Wiki articles.
//============================================================ //============================================================
============================ ============================
|| Table of Contents || || Table of Contents ||
============================ ============================
|| 1. What is rAthena? || || 1. What is rAthena? ||
|| 2. Prerequisits || || 2. Prerequisites ||
|| 3. Installation || || 3. Installation ||
|| 4. Troubleshooting || || 4. Troubleshooting ||
|| 5. Helpful Links || || 5. Helpful Links ||
@ -24,7 +24,7 @@
============================ ============================
|| 1. What is rAthena? || || 1. What is rAthena? ||
============================ ============================
rAthena is a collaborative software development project revolving around the rAthena is a collaborative software development project revolving around the
creation of a robust massively multiplayer online role playing game (MMORPG) creation of a robust massively multiplayer online role playing game (MMORPG)
server package. Written in C, the program is very versatile and provides NPCs, server package. Written in C, the program is very versatile and provides NPCs,
warps and modifications. The project is jointly managed by a group of volunteers warps and modifications. The project is jointly managed by a group of volunteers
@ -34,34 +34,34 @@ support. rAthena is a continuation of the eAthena project.
============================ ============================
|| 2. Prerequisists || || 2. Prerequisites ||
============================ ============================
Before installing rAthena there are certain tools and applications you will need. Before installing rAthena there are certain tools and applications you will need.
This differs between the varying operating systems available, so the following This differs between the varying operating systems available, so the following
is broken down into Windows and linux prerequisists. is broken down into Windows and Linux prerequisites.
Windows Windows
* TortoiseSVN (http://tortoisesvn.net/downloads.html) * TortoiseSVN (http://tortoisesvn.net/downloads.html)
* MySQL (http://www.mysql.com/downloads/mysql/) * MySQL (http://www.mysql.com/downloads/mysql/)
* MySQL Workbench (http://www.mysql.com/downloads/workbench/) * MySQL Workbench (http://www.mysql.com/downloads/workbench/)
* MS Visual C++ (http://www.microsoft.com/visualstudio/en-us/products/2010-editions/visual-cpp-express) * MS Visual C++ (http://www.microsoft.com/visualstudio/en-us/products/2010-editions/visual-cpp-express)
Linux (names of packages may require specific version numbers on certain distributions) Linux (names of packages may require specific version numbers on certain distributions)
* gcc * gcc
* make * make
* mysql * mysql
* mysql-devel * mysql-devel
* mysql-server * mysql-server
* pcre-devel * pcre-devel
* subversion * subversion
* zlib-devel * zlib-devel
============================ ============================
|| 3. Installation || || 3. Installation ||
============================ ============================
This section is a very brief set of installation instructions. For more concise guides This section is a very brief set of installation instructions. For more concise guides
relevant to your Operation System, please refer to the Wiki (links at the end of this file). relevant to your Operation System, please refer to the Wiki (links at the end of this file).
Windows Windows
@ -91,7 +91,7 @@ Linux
============================ ============================
|| 4. Troubleshooting || || 4. Troubleshooting ||
============================ ============================
If you're having problems with starting your server, the first thing you should If you're having problems with starting your server, the first thing you should
do is check what's happening on your consoles. More often that not, all support issues do is check what's happening on your consoles. More often that not, all support issues
can be solved simply by looking at the error messages given. can be solved simply by looking at the error messages given.
@ -134,44 +134,44 @@ Examples:
============================ ============================
|| 5. Helpful Links || || 5. Helpful Links ||
============================ ============================
The following list of links point to various helpfiles within the SVN, articles or The following list of links point to various help files within the SVN, articles or
pages on the wiki or topics within the rAthena forum. pages on the Wiki or topics within the rAthena forum.
* rAthena Forums * rAthena Forums
http://rathena.org/ http://rathena.org/
* SVN Repository URL: * SVN Repository URL:
https://rathena.svn.sourceforge.net/svnroot/rathena/trunk/ https://rathena.svn.sourceforge.net/svnroot/rathena/trunk/
* Full Installation Instructions: * Full Installation Instructions:
Windows http://rathena.org/wiki/Installation_on_Windows Windows http://rathena.org/wiki/Installation_on_Windows
CentOS http://rathena.org/wiki/Installation_(CentOS) CentOS http://rathena.org/wiki/Installation_(CentOS)
Debian http://rathena.org/wiki/Installation_(Debian) Debian http://rathena.org/wiki/Installation_(Debian)
* rAthena IRC Channel * rAthena IRC Channel
irc://irc.rathena.net irc://irc.rathena.net
============================ ============================
|| 6. More Documentation || || 6. More Documentation ||
============================ ============================
rAthena has a large collection of help files and sample NPC scripts located in /doc/ rAthena has a large collection of help files and sample NPC scripts located in /doc/
* Scripting * Scripting
It is recommended to look through /doc/script_commands.txt for help, pointers or It is recommended to look through /doc/script_commands.txt for help, pointers or
even for ideas for your next NPC script. Most script commands have a usage example. even for ideas for your next NPC script. Most script commands have a usage example.
* @commands * @commands
In-game, Game Masters have the ability to use Atcommands (@) to control players, In-game, Game Masters have the ability to use Atcommands (@) to control players,
create items, spawn mobs, reload configuration files and even control the weather. create items, spawn mobs, reload configuration files and even control the weather.
For an in-depth explaination, please see /doc/atcommands.txt For an in-depth explanation, please see /doc/atcommands.txt
* Permissions * Permissions
The rAthena emulator has a permission system that enables certain groups of players The rAthena emulator has a permission system that enables certain groups of players
to perform certain actions, or have access to certain visual enhancements or in-game to perform certain actions, or have access to certain visual enhancements or in-game
activity. To see what permissions are available, they are detailed in /doc/permissions.txt activity. To see what permissions are available, they are detailed in /doc/permissions.txt
There are more files in the /doc/ directory that will help you to create scripts or update the There are more files in the /doc/ directory that will help you to create scripts or update the
mapcache, er even explain how the job system and item bonuses work. Before posting a topic asking mapcache, or even explain how the job system and item bonuses work. Before posting a topic asking
for help on the forums, we reccomend that all users take the time to look over this directory. for help on the forums, we recommend that all users take the time to look over this directory.

21
doc/script_commands.txt
View File

@ -6575,8 +6575,13 @@ The commands can also run without an attached rid.
*bindatcmd("command","<NPC object name>::<event label>"{,<atcommand level>,<charcommand level>}); *bindatcmd("command","<NPC object name>::<event label>"{,<atcommand level>,<charcommand level>});
This command will bind a NPC event label to an atcommand. Upon execution of the This command will bind a NPC event label to an atcommand. Upon execution of the
atcommand, the user will invoke the NPC event label. An array .@atcmd_parameters$[] atcommand, the user will invoke the NPC event label. Each atcommand is only allowed
will be filled with the given parameters, starting with an index of 0. one binding. If you rebind, it will override the original binding.
The following variables are created upon execution:
.@atcmd_command$: The atcmd used.
.@atcmd_numparameters: The number of parameters defined.
.@atcmd_parameters$[]: Array containing the given parameters, starting from an index of 0.
Example: Example:
@ -6603,16 +6608,8 @@ This command will unbind a NPC event label from an atcommand.
*useatcmd "command"; *useatcmd "command";
*useatcmd("command"); *useatcmd("command");
This command will execute a custom atcommand on the attached RID from a script. This command will execute an atcommand binding on the attached RID from a script.
Whether invoked by a script or command, an array .@atcmd_parameters$[] will be Variables will not be created when invoking scripts with this command.
filled with the given parameters, starting with an index of 0.
Example:
@test Testing Command
The following array values will be generated:
.@atcmd_parameters$[0] = "Testing"
.@atcmd_parameters$[1] = "Command"
--------------------------------------- ---------------------------------------