summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHaru <haru@dotalux.com>2020-04-05 23:41:17 +0200
committerGitHub <noreply@github.com>2020-04-05 23:41:17 +0200
commita77dc973845efc6e45c5eea9513f6a161893c201 (patch)
tree47ac11b91dd4343a3d429b3651dc3c0202a546f3 /doc
parent413b7bbe5905bdd4ae790b8dce3ef869433e2b25 (diff)
parent588a8997817621f1bc65c9ccb999d5cda3e3fb4d (diff)
downloadhercules-a77dc973845efc6e45c5eea9513f6a161893c201.tar.gz
hercules-a77dc973845efc6e45c5eea9513f6a161893c201.tar.bz2
hercules-a77dc973845efc6e45c5eea9513f6a161893c201.tar.xz
hercules-a77dc973845efc6e45c5eea9513f6a161893c201.zip
Merge pull request #2668 from Kenpachi2k13/extend_pcblock_commands
Extend *pcblock script commands
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