summaryrefslogtreecommitdiff
path: root/doc/script_commands.txt
diff options
context:
space:
mode:
authorgumi <mekolat@users.noreply.github.com>2017-09-18 15:52:22 -0400
committergumi <mekolat@users.noreply.github.com>2017-09-18 15:52:22 -0400
commit604a6bea58bc15ba8786defb2dab749d4d107b15 (patch)
treee1befaca74f7fb51e858180628417dc0f95d310e /doc/script_commands.txt
parent03265815adbcaa2d5735028e5afafb4fca62ef7f (diff)
downloadhercules-604a6bea58bc15ba8786defb2dab749d4d107b15.tar.gz
hercules-604a6bea58bc15ba8786defb2dab749d4d107b15.tar.bz2
hercules-604a6bea58bc15ba8786defb2dab749d4d107b15.tar.xz
hercules-604a6bea58bc15ba8786defb2dab749d4d107b15.zip
update the documentation for useatcmd following deprecation
Diffstat (limited to 'doc/script_commands.txt')
-rw-r--r--doc/script_commands.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 4a3a7d6ad..3457d50f0 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -7874,10 +7874,19 @@ This command will unbind a NPC event label from an atcommand.
*useatcmd("command")
+ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+ @ /!\ This command is deprecated @
+ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+
This command will execute an atcommand binding on the attached RID from a
script. The three .@atcmd_***** variables will NOT be set when invoking
scripts-atcommands this way.
+This command is deprecated and it should not be used in new scripts, as it is
+likely to be removed at a later time. Instead, you should directly call to the
+event label of the binding using timers or doevent(). For built-in commands,
+atcommand() should be used instead.
+
---------------------------------------
*can_use_command("<command>"{, <account id>})