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.txt18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 1c75bb062..29e9edee4 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -135,6 +135,8 @@
//= 3.28.20091119
//= Added showevent and searchitem commands [Skotlex]
//= Added info on strcharinfo(3) [Skotlex]
+//= 3.29.20101123
+//= Added 'pushpc' command. [Ai4rei]
//=========================================================
This document is a reference manual for all the scripting commands and functions
@@ -3870,6 +3872,22 @@ you can look at, this may help you create a Stylist of your own:
'custom\dye.txt'
---------------------------------------
+
+*pushpc <direction>,<cells>;
+
+This command will push the currently attached player to given direction by given
+amount of square cells. Direction is the same as used when declaring npcs, and
+can be specified by using one of the DIR_* constants (db/const.txt).
+
+The knock-back is not restricted by items or map flags, only obstacles are taken
+into account. If there is not enough space to perform the push (e.g. due to a
+wall), the character is pushed only up to the obstacle.
+
+ // pushes the character 5 cells in 3 o'clock direction from it's
+ // current position.
+ pushpc DIR_EAST, 5;
+
+---------------------------------------
\\
4,1.- Item-related commands
\\