summaryrefslogtreecommitdiff
path: root/doc/script_commands.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/script_commands.txt')
-rw-r--r--doc/script_commands.txt17
1 files changed, 7 insertions, 10 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 0362e5a87..50c364de3 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -6572,16 +6572,15 @@ The commands can also run without an attached rid.
---------------------------------------
*bindatcmd "command","<NPC object name>::<event label>"{,<atcommand level>,<charcommand level>};
-*bindatcmd("command","<NPC object name>::<event label>"{,<atcommand level>,<charcommand level>});
This command will bind a NPC event label to an atcommand. Upon execution of the
atcommand, the user will invoke the NPC event label. Each atcommand is only allowed
one binding. If you rebind, it will override the original binding.
-The following variables are created upon execution:
- .@atcmd_command$: The atcmd used.
- .@atcmd_numparameters: The number of parameters defined.
- .@atcmd_parameters$[]: Array containing the given parameters, starting from an index of 0.
+The following variables are set upon execution:
+ .@atcmd_command$ = The name of the @command used.
+ .@atcmd_parameters$[] = Array containing the given parameters, starting from an index of 0.
+ .@atcmd_numparameters = The number of parameters defined.
Example:
@@ -6589,7 +6588,7 @@ When a user types the command "@test", an angel effect will be shown.
- script atcmd_example -1,{
OnInit:
- bindatcmd("test","atcmd_example::OnAtcommand");
+ bindatcmd "test",strnpcinfo(3)+"::OnAtcommand";
end;
OnAtcommand:
specialeffect2 338;
@@ -6599,17 +6598,15 @@ OnAtcommand:
---------------------------------------
*unbindatcmd "command";
-*unbindatcmd("command");
This command will unbind a NPC event label from an atcommand.
---------------------------------------
*useatcmd "command";
-*useatcmd("command");
-This command will execute an atcommand binding on the attached RID from a script.
-Variables will not be created when invoking scripts with this command.
+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.
---------------------------------------