summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorgumi <mekolat@users.noreply.github.com>2017-06-03 12:52:53 -0400
committergumi <mekolat@users.noreply.github.com>2017-06-03 12:57:41 -0400
commit9913f13573d737b4c54c7cad23b77c6a940fe8f4 (patch)
tree7d7e1a7a04081ce9725f771402a88a09d859f5e6 /doc
parent53c6feb18fb994516945901853d845cdc5e27529 (diff)
downloadhercules-9913f13573d737b4c54c7cad23b77c6a940fe8f4.tar.gz
hercules-9913f13573d737b4c54c7cad23b77c6a940fe8f4.tar.bz2
hercules-9913f13573d737b4c54c7cad23b77c6a940fe8f4.tar.xz
hercules-9913f13573d737b4c54c7cad23b77c6a940fe8f4.zip
flag misceffect() as deprecated
Diffstat (limited to 'doc')
-rw-r--r--doc/script_commands.txt9
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index a7eb55073..34089f767 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -7635,6 +7635,10 @@ without event labels. If specified name is not found, command does nothing.
*misceffect(<effect number>)
+ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+ @ /!\ This command is deprecated @
+ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+
This command, if run from an NPC object that has a sprite, will call up a
specified effect number, centered on the NPC sprite. If the running code
does not have an object ID (a 'floating' NPC) or is not running from an
@@ -7643,8 +7647,9 @@ character who's RID got attached to the script, if any. For usable item
scripts, this command will create an effect centered on the player using
the item.
-A full list of known effects is found in 'doc/effect_list.txt'. The list
-of those that actually work may differ greatly between client versions.
+This command is deprecated and it should not be used in new scripts, as it is
+likely to be removed at a later time. Please use specialeffect instead,
+ie: specialeffect(<effect number>, <send target>, <unit id>)
---------------------------------------