summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorgumi <mekolat@users.noreply.github.com>2017-05-15 12:20:57 -0400
committergumi <mekolat@users.noreply.github.com>2017-05-28 11:51:39 -0400
commit7fa9eb8ecdeafe520fadf865ad8463a9ac1b47cb (patch)
tree162787571818024fc41b5db10614f21fad526961
parenta24eeb0c19b5301330fe532ecf575a84c13a6c9b (diff)
downloadhercules-7fa9eb8ecdeafe520fadf865ad8463a9ac1b47cb.tar.gz
hercules-7fa9eb8ecdeafe520fadf865ad8463a9ac1b47cb.tar.bz2
hercules-7fa9eb8ecdeafe520fadf865ad8463a9ac1b47cb.tar.xz
hercules-7fa9eb8ecdeafe520fadf865ad8463a9ac1b47cb.zip
update documentation for add_group_command
-rw-r--r--doc/script_commands.txt18
1 files changed, 17 insertions, 1 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 0ba350ad1..3b01d8977 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -7773,6 +7773,21 @@ OnAtcommand:
---------------------------------------
+*add_group_command("<command>", <group id>, <use on self>, <use on other>)
+
+Allows to explicitly change the command permissions for a specific group.
+
+This command bypasses group inheritance, which means groups inheriting from
+the specified <group id> will NOT inherit the specified permission. You should
+use add_group_command() for every group you want to give permission to.
+
+Example:
+ bindatcmd("foobar", "NPC::OnUseCommand", 99, 99, 0); // define the command
+ add_group_command("foobar", 2, true, false); // allow group 2 to use @foobar
+ add_group_command("foobar", 5, true, true); // allow group 5 to use @foobar and #foobar
+
+---------------------------------------
+
*unbindatcmd("command")
This command will unbind a NPC event label from an atcommand.
@@ -7790,7 +7805,8 @@ scripts-atcommands this way.
*can_use_command("<command>"{, <account id>})
Checks if the attached or specified player can use the specified
-atcommand and returns true or false accordingly.
+atcommand and returns true or false accordingly. Works for both
+built-in atcommands and custom atcommands.
---------------------------------------