summaryrefslogtreecommitdiff
path: root/doc/script_commands.txt
diff options
context:
space:
mode:
authorHaru <haru@dotalux.com>2018-10-22 00:31:55 +0200
committerGitHub <noreply@github.com>2018-10-22 00:31:55 +0200
commit370d3290b4b17cef8da86789a847507644de210d (patch)
tree5ae21d106c03945377830fd24f9d5b7efcc7e7ab /doc/script_commands.txt
parentc88c3d485e6471c09b87f596ef735dde2b975d1b (diff)
parentdb3e3bc2df1467565b4e8efbe69cdbde7510cfd7 (diff)
downloadhercules-370d3290b4b17cef8da86789a847507644de210d.tar.gz
hercules-370d3290b4b17cef8da86789a847507644de210d.tar.bz2
hercules-370d3290b4b17cef8da86789a847507644de210d.tar.xz
hercules-370d3290b4b17cef8da86789a847507644de210d.zip
Merge pull request #2249 from Asheraf/pr1
Add missing documentation for script command achievement_progress()
Diffstat (limited to 'doc/script_commands.txt')
-rw-r--r--doc/script_commands.txt14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 5cba5afc8..1d691774a 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -10200,3 +10200,17 @@ camera.
Works for 20160525 clients or newer.
---------------------------------------
+
+*achievement_progress(<ach_id>, <obj_idx>, <progress>, <incremental>{, <account_id>});
+
+Make the player progress in the specified achievement.
+aid - achievement ID
+obj_idx - achievement objective index.
+progress - objective progress towards goal.
+incremental - (boolean) true to add the progress towards the goal,
+ false to use the progress only as a comparand.
+account_id - (optional) AID to perform on (default to attached player).
+
+returns progress on success and false on failure
+
+---------------------------------------