summaryrefslogtreecommitdiff
path: root/doc/script_commands.txt
diff options
context:
space:
mode:
authorgumi <mekolat@users.noreply.github.com>2017-04-24 12:17:15 -0400
committergumi <mekolat@users.noreply.github.com>2017-04-25 11:14:56 -0400
commit7afb1a56559f4b1e35c68b20e282b923c4d7a0ba (patch)
tree28541065c57f8ae4c67bd393e0a26e97726831a6 /doc/script_commands.txt
parent89ffb3db746b016ea1cc12ef2f148152ed280172 (diff)
downloadhercules-7afb1a56559f4b1e35c68b20e282b923c4d7a0ba.tar.gz
hercules-7afb1a56559f4b1e35c68b20e282b923c4d7a0ba.tar.bz2
hercules-7afb1a56559f4b1e35c68b20e282b923c4d7a0ba.tar.xz
hercules-7afb1a56559f4b1e35c68b20e282b923c4d7a0ba.zip
add permission checking buildins
add has_permission() add can_use_command() expose PC permission constants
Diffstat (limited to 'doc/script_commands.txt')
-rw-r--r--doc/script_commands.txt62
1 files changed, 62 insertions, 0 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index e4df77051..e2b96cb5f 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -7760,6 +7760,68 @@ 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.
+
+---------------------------------------
+
+*has_permission(<permission>{, <account id>})
+*has_permission("<permission>"{, <account id>})
+
+Check if the attached or specified player has the specified permission
+and returns true or false accordingly. See doc/permissions.txt for
+details about permissions.
+
+Valid <permission> are:
+
+ PERM_TRADE
+ PERM_PARTY
+ PERM_ALL_SKILL
+ PERM_USE_ALL_EQUIPMENT
+ PERM_SKILL_UNCONDITIONAL
+ PERM_JOIN_ALL_CHAT
+ PERM_NO_CHAT_KICK
+ PERM_HIDE_SESSION
+ PERM_WHO_DISPLAY_AID
+ PERM_RECEIVE_HACK_INFO
+ PERM_WARP_ANYWHERE
+ PERM_VIEW_HPMETER
+ PERM_VIEW_EQUIPMENT
+ PERM_USE_CHECK
+ PERM_USE_CHANGEMAPTYPE
+ PERM_USE_ALL_COMMANDS
+ PERM_RECEIVE_REQUESTS
+ PERM_SHOW_BOSS
+ PERM_DISABLE_PVM
+ PERM_DISABLE_PVP
+ PERM_DISABLE_CMD_DEAD
+ PERM_HCHSYS_ADMIN
+ PERM_TRADE_BOUND
+ PERM_DISABLE_PICK_UP
+ PERM_DISABLE_STORE
+ PERM_DISABLE_EXP
+ PERM_DISABLE_SKILL_USAGE
+
+Example:
+
+ if (has_permission(PERM_WARP_ANYWHERE)) {
+ //do something
+ }
+
+It is also possible to pass a string for plugin permissions:
+
+ if (has_permission("show_version")) {
+ //do something
+ }
+
+** Passing a string is slower than passing a constant because
+ the engine has to loop through the array to find the permission.
+ In most cases you should use the PERM_ constants.
+
+---------------------------------------
+
*unitskilluseid(<GID>, <skill id>, <skill lvl>{, <target id>})
*unitskilluseid(<GID>, "<skill name>", <skill lvl>{, <target id>})
*unitskillusepos(<GID>, <skill id>, <skill lvl>, <x>, <y>)