summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDastgir Pojee <dastgirpojee@rocketmail.com>2014-05-31 02:43:51 +0200
committerHaru <haru@dotalux.com>2014-05-31 03:10:15 +0200
commit49500a5e4055673d082b6f9c4d92cd4a9f04c230 (patch)
treecef73155a726b6e51ce2eced481737459ce79c9f /doc
parent09e774ed47bae57c70497294d8261e4917c57896 (diff)
downloadhercules-49500a5e4055673d082b6f9c4d92cd4a9f04c230.tar.gz
hercules-49500a5e4055673d082b6f9c4d92cd4a9f04c230.tar.bz2
hercules-49500a5e4055673d082b6f9c4d92cd4a9f04c230.tar.xz
hercules-49500a5e4055673d082b6f9c4d92cd4a9f04c230.zip
Extended ItemDB to support several other formats (part 1)
- Updated item_db.conf in preparation for the source edits. Signed-off-by: Haru <haru@dotalux.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/item_db.txt75
1 files changed, 74 insertions, 1 deletions
diff --git a/doc/item_db.txt b/doc/item_db.txt
index 7035ed684..ce2a248ca 100644
--- a/doc/item_db.txt
+++ b/doc/item_db.txt
@@ -34,6 +34,26 @@ item_db: (
Refine: Refineable (boolean, defaults to true)
View: View ID (int, defaults to 0)
BindOnEquip: true/false (boolean, defaults to false)
+ BuyingStore: true/false (boolean, defaults to false)
+ Delay: Delay to use item (int, defaults to 0)
+ Trade: { (defaults to no restrictions)
+ override: GroupID (int, defaults to 100)
+ nodrop: true/false (boolean, defaults to false)
+ notrade: true/false (boolean, defaults to false)
+ partneroverride: true/false (boolean, defaults to false)
+ noselltonpc: true/false (boolean, defaults to false)
+ nocart: true/false (boolean, defaults to false)
+ nostorage: true/false (boolean, defaults to false)
+ nogstorage: true/false (boolean, defaults to false)
+ nomail: true/false (boolean, defaults to false)
+ noauction: true/false (boolean, defaults to false)
+ }
+ Nouse: { (defaults to no restrictions)
+ override: GroupID (int, defaults to 100)
+ sitting: true/false (boolean, defaults to false)
+ }
+ Stack: [amount, flag] (int, defaults to 0)
+ Sprite: SpriteID (int, defaults to 0)
Script: <"
Script
(it can be multi-line)
@@ -220,7 +240,60 @@ View: For normal items, defines a replacement view-sprite for the item (eg:
BindOnEquip: Whether the item will automatically bind to the character when it
is equipped for the first time. An item that has this field set,
will display a confirmation dialog the first time it is equipped,
- and, if accepted, the item will become character-bound.
+ and, if accepted, the item will become character-bound.
+
+BuyingStore: Whether the item can be sold via buyingstore, one must also edit
+ data\buyingstoreitemlist.txt for client to accept item.
+
+Delay: Delay for an item to be used again. Value is in milliseconds.
+ There is a max concurrent number of entries modifiable in
+ src/map/itemdb.h as MAX_ITEMDELAYS.
+
+Trade: Item trade restrictions. If this block is omitted, the item will have no
+ trade restrictions.
+ All the settings in this group are boolean values, unless otherwise
+ specified. Default value is false (restriction not set) for any missing
+ setting.
+
+ Allowed settings in this block are:
+ override: If specified and in the interval [1:100], sets the
+ minimum GM Group ID that can bypass the defined trade
+ restrictions. This is an integer value.
+ nodrop: Item can't be dropped.
+ notrade: Item can't be traded (nor vended).
+ partneroverride: Wedded partners can override the notrade setting.
+ noselltonpc: Item can't be sold to NPCs.
+ nocart: Item can't be placed in the cart.
+ nostorage: Item can't be placed in the storage.
+ nogstorage: Item can't be placed in the guild storage.
+ nomail: Item can't be attached to mail messages.
+ noauction: Item can't be auctioned.
+
+Nouse: Defines if an item cannot be used under certain circumstances. If this
+ block is omitted, there will be no usage restrictions.
+ All the settings in this group are boolean values, unless otherwise
+ specified. Default value is false (restriction not set) for any missing
+ setting.
+
+ Allowed settings in this block are:
+ override: If specified and in the interval [1:100], sets the
+ minimum GM Group ID that can bypass the defined usage
+ restrictions. This is an integer value.
+ sitting: Item can't be used while sitting.
+
+Stack: Prevents an item to be stacked more than x times in given
+ inventory types. Generally used by 3rd class related skill items.
+ Syntax: [amount, type]
+ Available types:
+ 1: Character inventory restriction
+ 2: Character cart restriction
+ 4: Account storage restriction
+ 8: Guild storage restriction
+ Note: Stack limit of 0 will disable a restriction.
+
+Sprite: SpriteID will be sent to the client instead of ItemID.
+ NOTE: Replaces an item client-side while keeping them separate server-side.
+ Think of it as a way to disguise items.
Script: Script to execute when the item is used/equipped.