From d20cbae7763546555c4c9c8aa53266c40b31a2b1 Mon Sep 17 00:00:00 2001
From: Emistry Haoyan <equinox1991@gmail.com>
Date: Tue, 9 Apr 2019 23:23:33 +0800
Subject: Add *setfavoriteitemidx & *autofavoriteitem script command.

- set an item as favorite item or not based inventory
index.
- if an item is set to favorite item, it will be moved into favorite
tab, else move out from favorite tab.
- only non-equipped item can adjust the favorite item state.
---
 doc/script_commands.txt | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

(limited to 'doc/script_commands.txt')

diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 516454365..03a45017a 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -3192,6 +3192,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
-- 
cgit v1.2.3-60-g2f50