summaryrefslogtreecommitdiff
path: root/doc/script_commands.txt
diff options
context:
space:
mode:
authorHaru <haru@dotalux.com>2019-06-30 21:03:47 +0200
committerGitHub <noreply@github.com>2019-06-30 21:03:47 +0200
commit60cbf12662c9cb481c6b93cec8778e93fa8f8d3d (patch)
tree9b75e97b6cb788959a9d4bc2c237ac8409d9e705 /doc/script_commands.txt
parent238cfaa6b6496da1a8569ad0a6f50d2c722c7d54 (diff)
parentd20cbae7763546555c4c9c8aa53266c40b31a2b1 (diff)
downloadhercules-60cbf12662c9cb481c6b93cec8778e93fa8f8d3d.tar.gz
hercules-60cbf12662c9cb481c6b93cec8778e93fa8f8d3d.tar.bz2
hercules-60cbf12662c9cb481c6b93cec8778e93fa8f8d3d.tar.xz
hercules-60cbf12662c9cb481c6b93cec8778e93fa8f8d3d.zip
Merge pull request #2427 from Emistry/scriptcommand_setfavoriteitem
Add *setfavoriteitemidx & *autofavoriteitem script commands - alter item favorite state
Diffstat (limited to 'doc/script_commands.txt')
-rw-r--r--doc/script_commands.txt24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index a08d8a71c..5cc3ea186 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -3207,6 +3207,30 @@ runs of getcartinventorylist().
---------------------------------------
+*setfavoriteitemidx(<idx>, <flag>)
+
+This function will set an item in inventory as favorite or not.
+If its favorite item, it will be moved to favorite tab, else move out from favorite tab.
+Note: Cant change favorite flag of an equipped item.
+
+Valid Parameters:
+ <idx> - inventory index, refer *getinventorylist()
+ <flag> - true/false (true = favorite item, false = otherwise)
+
+---------------------------------------
+
+*autofavoriteitem(<item_id>, <flag>)
+
+This function will auto set an item as favorite when <item_id> is obtained.
+If its favorite item, it will be auto moved to favorite tab, else move out from favorite tab.
+This setting affect not only attached player, but also everyone player globally.
+
+Valid Parameters:
+ <item_id> - item ID
+ <flag> - true/false (true = favorite item, false = otherwise)
+
+---------------------------------------
+
*cardscnt()
This function will return the number of cards inserted into the weapon