summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorgumi <mekolat@users.noreply.github.com>2017-05-27 12:11:10 -0400
committergumi <mekolat@users.noreply.github.com>2017-06-03 12:57:17 -0400
commitec5807f72c2956c3cc1ea5ddfe0498e3a8a6326e (patch)
tree809a60cd24c6ce51bf19f2347de8ae1bdf905385 /doc
parent289365d08535bc626f700e9c7ac47fef5a2d3370 (diff)
downloadhercules-ec5807f72c2956c3cc1ea5ddfe0498e3a8a6326e.tar.gz
hercules-ec5807f72c2956c3cc1ea5ddfe0498e3a8a6326e.tar.bz2
hercules-ec5807f72c2956c3cc1ea5ddfe0498e3a8a6326e.tar.xz
hercules-ec5807f72c2956c3cc1ea5ddfe0498e3a8a6326e.zip
update the documentation for specialeffect()
Diffstat (limited to 'doc')
-rw-r--r--doc/script_commands.txt27
1 files changed, 20 insertions, 7 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 861b9cc59..c11ee29a9 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -5819,7 +5819,8 @@ map as the invoking character.
---------------------------------------
-*specialeffect(<effect number>{, <send_target>{, "<NPC Name>"}})
+*specialeffect(<effect number>{, <send_target>{, <unit id>{, <account id>}}})
+*specialeffect(<effect number>{, <send_target>{, "<NPC Name>"{, <account id>}}})
This command will display special effect with the given number, centered
on the specified NPCs coordinates, if any. For a full list of special
@@ -5832,13 +5833,25 @@ NPC specified does not exist, the command will do nothing. When specifying
an NPC, <send_target> must be specified when specifying an <NPC Name>,
specifying AREA will retain the default behavior of the command.
- // this will make the NPC "John Doe#1"
- // show the effect "EF_HIT1" specified by
- // Jane Doe. I wonder what John did...
- mes("[Jane Doe]");
- mes("Well, I never!");
+<unit id> behaves like <NPC Name> except it can display the effect on
+any kind of unit, not just NPC, by specifying its GID.
+
+When <send_target> is SELF you can specify which player to send the effect
+to by passing <account id>.
+
+Example usage:
+
+ // To make a NPC do an effect and show it to everyone:
specialeffect(EF_HIT1, AREA, "John Doe#1");
- close();
+
+ // To make a player do an effect and show it to everyone:
+ specialeffect(EF_HIT1, AREA, getcharid(CHAR_ID_ACCOUNT, "player"));
+
+ // To make a NPC do an effect and show it only to the attached player:
+ specialeffect(EF_HIT1, SELF, "John Doe#1");
+
+ // To make a NPC do an effect and show it only to another player:
+ specialeffect(EF_HIT1, SELF, "John Doe#1", getcharid(CHAR_ID_ACCOUNT, "player"));
---------------------------------------