summaryrefslogtreecommitdiff
path: root/doc/script_commands.txt
diff options
context:
space:
mode:
authorultramage <ultramage@54d463be-8e91-2dee-dedb-b68131a5f0ec>2008-03-27 18:27:22 +0000
committerultramage <ultramage@54d463be-8e91-2dee-dedb-b68131a5f0ec>2008-03-27 18:27:22 +0000
commite947a57dc1c14cc01ebf0d3a6d0e72af4c9a43c7 (patch)
tree748294ed41a854b52fba9733959a3604736e9aac /doc/script_commands.txt
parent1740acaa418d4f7c079f43e5bdf8bb36ef73d4f6 (diff)
downloadhercules-e947a57dc1c14cc01ebf0d3a6d0e72af4c9a43c7.tar.gz
hercules-e947a57dc1c14cc01ebf0d3a6d0e72af4c9a43c7.tar.bz2
hercules-e947a57dc1c14cc01ebf0d3a6d0e72af4c9a43c7.tar.xz
hercules-e947a57dc1c14cc01ebf0d3a6d0e72af4c9a43c7.zip
Added proper script constants and documentation for the 'checkcell' command. (topic:183035)
git-svn-id: https://rathena.svn.sourceforge.net/svnroot/rathena/trunk@12443 54d463be-8e91-2dee-dedb-b68131a5f0ec
Diffstat (limited to 'doc/script_commands.txt')
-rw-r--r--doc/script_commands.txt41
1 files changed, 40 insertions, 1 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index cd687cc90..611e38bbc 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.17.20080312
+//= 3.18.20080327
//=========================================================
//= 1.0 - First release, filled will as much info as I could
//= remember or figure out, most likely there are errors,
@@ -106,6 +106,8 @@
//= Woopth. Fixed spelling. ;P Should be a bit clearer now. [L0ne_W0lf]
//= 3.17.20080312
//= Corrected cashshop description. (#FREEPOINTS->#KAFRAPOINTS) [L0ne_W0lf]
+//= 3.18.20080327
+//= Added documentation for the 'checkcell' command [ultramage]
//=========================================================
This document is a reference manual for all the scripting commands and functions
@@ -6176,5 +6178,42 @@ to proceed until all barricades are destroyed. This script would place and
remove a nonwalkable row of cells after the barricade mobs.
---------------------------------------
+
+*checkcell ("<map name>",<x>,<y>,<type>);
+
+This command will return 1 or 0, depending on whether the specified cell has
+the 'type' flag set or not. There are various types to check, all mimicking
+the server's cell_chk enumeration. The types can be found in db/const.txt.
+
+The meaning of the individual types can be confusing, so here's an overview:
+ - cell_chkwall/water/cliff
+ these check directly for the 'terrain component' of the specified cell
+ - cell_chkpass/reach/nopass/noreach
+ passable = not wall & not cliff, reachable = passable wrt. no-stacking mod
+ - cell_chknpc/basilica/landprotector/novending/nochat
+ these check for specific dynamic flags (their name indicates what they do)
+
+Example:
+
+ mes "Pick a destination map.";
+ input .@map$;
+ mes "Alright, now give me the coordinates.";
+ input .@x;
+ input .@y;
+ if( !checkcell(.@map$,.@x,.@y,cell_chkpass) )
+ {
+ mes "Can't warp you there, sorry!";
+ close;
+ }
+ else
+ {
+ mes "Ok, get ready...";
+ close2;
+ warp .@map$, .@x, .@y;
+ end;
+ }
+
+---------------------------------------
+
Whew.
That's about all of them.