summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorKenpachi Developer <Kenpachi.Developer@gmx.de>2020-03-28 00:17:23 +0100
committerKenpachi Developer <Kenpachi.Developer@gmx.de>2020-03-28 00:17:23 +0100
commit588a8997817621f1bc65c9ccb999d5cda3e3fb4d (patch)
tree9c12eab796ef65a2394c488f6300a3b15ed0bff1 /doc
parent18b3aca223b8383dc51bb33886421196181543af (diff)
downloadhercules-588a8997817621f1bc65c9ccb999d5cda3e3fb4d.tar.gz
hercules-588a8997817621f1bc65c9ccb999d5cda3e3fb4d.tar.bz2
hercules-588a8997817621f1bc65c9ccb999d5cda3e3fb4d.tar.xz
hercules-588a8997817621f1bc65c9ccb999d5cda3e3fb4d.zip
Update doc/script_commands.txt
Diffstat (limited to 'doc')
-rw-r--r--doc/script_commands.txt11
1 files changed, 8 insertions, 3 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 392aa0c1f..3b77aeb2c 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -6575,17 +6575,22 @@ Examples:
---------------------------------------
-*setpcblock(<type>,<option>)
-*checkpcblock()
+*setpcblock(<type>, <option>{, <account id>})
+*checkpcblock({<account id>})
-Prevents the player from doing the following action.
+Prevents a character from doing the following action.
For setpcblock, when the <option> is true(1) will block them, and false(0)
will allow those actions again.
+The setpcblock command returns 1 on success or 0 if no character was attached.
+
The checkpcblock command returned value is a bit mask of the currently
enabled block flags (or PCBLOCK_NONE when none is set).
+Parameter <account id> is optional for both commands.
+If omitted, the currently attached character is used.
+
The <type> listed are a bit mask of the following:
PCBLOCK_NONE (only used by checkpcblock)
PCBLOCK_MOVE