* Documentation updates and fixes.

- Added documentation for script commands 'bg_getareausers' and 'bg_get_data' (bugreport:3034).
- Fixed documentation for script command 'waitingroom2bg_single' (bugreport:4770, since r14373).
- Documented optional parameter 'npc name' for script command 'waitingroom2bg'.

git-svn-id: https://rathena.svn.sourceforge.net/svnroot/rathena/trunk@14756 54d463be-8e91-2dee-dedb-b68131a5f0ec

1 files changed, 28 insertions, 8 deletions

diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 0be0460e1..2c8662cca 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -4,7 +4,7 @@
 //= A reference manual for the eAthena scripting language.
 //= Commands are sorted depending on their functionality.
 //===== Version ===========================================
-//= 3.38.20110313
+//= 3.39.20110322
 //=========================================================
 //= 1.0 - First release, filled will as much info as I could
 //=       remember or figure out, most likely there are errors,
@@ -162,6 +162,10 @@
 //= 3.38.20110313
 //=       Added 'cooking' command. [Ai4rei]
 //=       Fixed item levels in 'produce' command.
+//= 3.39.20110322
+//=       Added 'bg_getareausers' and 'bg_get_data' commands. [Ai4rei]
+//=       Updated description of 'waitingroom2bg_single' command.
+//=       Documented optional parameter 'npc name' of 'waitingroom2bg' command.
 //=========================================================
 
 This document is a reference manual for all the scripting commands and functions 
@@ -6839,9 +6843,9 @@ instance times out while inactive.
 
 ---------------------------------------
 
-========================
+=========================
 |8.- Quest Log commands.|
-========================
+=========================
 ---------------------------------------
 
 *setquest <ID>;
@@ -6910,13 +6914,20 @@ color can be:
 
 ----------------------------------------
 
-===========================
+============================
 |9.- Battleground commands.|
-===========================
+============================
 ---------------------------------------
 
-*waitingroom2bg_single("<mapname>",<x>,<y>,"<On Quit Event>","<On Death Event>");
-*waitingroom2bg("<mapname>",<x>,<y>,"<On Quit Event>","<On Death Event>");
+*waitingroom2bg_single(<battle group>,"<mapname>",<x>,<y>,"<npc name>");
+
+Adds the first waiting player from the chat room of given NPC to an
+existing battleground group and warps it to specified coordinates on
+given map.
+
+---------------------------------------
+
+*waitingroom2bg("<mapname>",<x>,<y>,"<On Quit Event>","<On Death Event>"{,"<npc name>"});
 
 <Mapname> and X Y coordinates refer to where the "respawn" base is, where the player group will respawn when they die.
 <On Quit Event> refers to an NPC label that attaches to the character and is run when they relog.
@@ -6925,6 +6936,8 @@ color can be:
 Unlike the prior command, the latter will attach a GROUP in a waiting room to the battleground, and 
 sets the array $@arenamembers[0] where 0 holds the IDs of the first group, and 1 holds the IDs of the second.
 
+If the option parameter is left out, the waiting room of the current NPC is used.
+
 Example:
 	// Battle Group will be referred to as $@KvM01BG_id1, and when they die, respawn at bat_c01,52,129.
 	set $@KvM01BG_id1, waitingroom2bg("bat_c01",52,129,"KvM01_BG::OnGuillaumeQuit","KvM01_BG::OnGuillaumeDie");
@@ -7022,9 +7035,16 @@ Example:
 
 *bg_get_data(<Battle Group>,<type>);
 
+Retrieves data related to given battle group. Type can be one of the following:
+
+    0 - Amount of players currently belonging to the group.
+
 ----------------------------------------
 
-*bg_getareausers
+*bg_getareausers(<battle group>,<map name>,<x0>,<y0>,<x1>,<y1>);
+
+Retrieves amount of players belonging to given battle group on given
+map within an specified rectangular area.
 
 ----------------------------------------