summaryrefslogtreecommitdiff
path: root/doc/script_commands.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/script_commands.txt')
-rw-r--r--doc/script_commands.txt7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index e3949afde..f63288da1 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -3701,7 +3701,7 @@ There are also three special 'map names' you can use.
---------------------------------------
-*areawarp "<from map name>",<x1>,<y1>,<x2>,<y2>,"<to map name>",<x3>,<y3>;
+*areawarp "<from map name>",<x1>,<y1>,<x2>,<y2>,"<to map name>",<x3>,<y3>{,<x4>,<y4>};
This command is similar to 'warp', however, it will not refer to the invoking
character, but instead, all characters within a specified area, defined by the
@@ -3719,6 +3719,11 @@ Y 150
By using ,0,0; as the destination coordinates it will take all the characters in
the affected area to a random set of co-ordinates on "place2".
+ areawarp "place",10,10,120,120,"place2",150,150,200,200;
+
+By using the optional x4 and y4 parameters, the destination coordinates will be a
+random place within the defined x3/y3-x4/y4 square.
+
Like 'warp', areawarp will also explicitly warp characters randomly into the
current map if you give the 'to map name' as "Random".