doc/item_db.txt

   1 //===== rAthena Documentation ================================
   2 //= Item Database
   3 //===== By: ==================================================
   4 //= rAthena Dev Team
   5 //===== Last Updated: ========================================
   6 //= 20160319
   7 //===== Description: =========================================
   8 //= Explanation of the item_db.txt file and structure.
   9 //============================================================
  10
  11 ---------------------------------------
  12
  13 ID: Item id
  14
  15 ---------------------------------------
  16
  17 AegisName: Server name to reference the item in scripts and lookups,
  18            should use no spaces.
  19
  20 ---------------------------------------
  21
  22 Name: Name in English for displaying as output for @ and script commands.
  23
  24 ---------------------------------------
  25
  26 Type:
  27         0       Healing item.
  28         2       Usable item.
  29         3       Etc item
  30         4       Armor/Garment/Boots/Headgear/Accessory
  31         5       Weapon
  32         6       Card
  33         7       Pet egg
  34         8       Pet equipment
  35         10      Ammo (Arrows/Bullets/etc)
  36         11      Usable with delayed consumption (intended for 'itemskill')
  37                 Items using the 'itemskill' script command are consumed after
  38                 selecting a target. Any other command will NOT consume the item.
  39         12      Shadow Equipment
  40         18      Another delayed consume that requires user confirmation before
  41                 using item.
  42
  43 ---------------------------------------
  44
  45 Buy: Default buying price. When not specified, becomes double the sell price.
  46
  47 ---------------------------------------
  48
  49 Sell: Default selling price. When not specified, becomes half the buy price.
  50
  51 ---------------------------------------
  52
  53 Weight: Item's weight. Each 10 is 1 weight.
  54
  55 ---------------------------------------
  56
  57 ATK: Weapon's attack
  58
  59 MATK: Weapon's magic attack (Renewal only)
  60
  61 ---------------------------------------
  62
  63 DEF: Armor's defense
  64
  65 ---------------------------------------
  66
  67 Range: Weapon's attack range
  68
  69 ---------------------------------------
  70
  71 Slots: Amount of slots the item possesses.
  72
  73 ---------------------------------------
  74
  75 Job: Equippable jobs. Uses the following bitmask table:
  76         (S.) Novice    (2^00): 0x00000001
  77         Swordman       (2^01): 0x00000002
  78         Magician       (2^02): 0x00000004
  79         Archer         (2^03): 0x00000008
  80         Acolyte        (2^04): 0x00000010
  81         Merchant       (2^05): 0x00000020
  82         Thief          (2^06): 0x00000040
  83         Knight         (2^07): 0x00000080
  84         Priest         (2^08): 0x00000100
  85         Wizard         (2^09): 0x00000200
  86         Blacksmith     (2^10): 0x00000400
  87         Hunter         (2^11): 0x00000800
  88         Assassin       (2^12): 0x00001000
  89         Unused         (2^13): 0x00002000
  90         Crusader       (2^14): 0x00004000
  91         Monk           (2^15): 0x00008000
  92         Sage           (2^16): 0x00010000
  93         Rogue          (2^17): 0x00020000
  94         Alchemist      (2^18): 0x00040000
  95         Bard/Dancer    (2^19): 0x00080000
  96         Unused         (2^20): 0x00100000
  97         Taekwon        (2^21): 0x00200000
  98         Star Gladiator (2^22): 0x00400000
  99         Soul Linker    (2^23): 0x00800000
 100         Gunslinger     (2^24): 0x01000000
 101         Ninja          (2^25): 0x02000000
 102         Gangsi         (2^26): 0x04000000
 103         Death Knight   (2^27): 0x08000000
 104         Dark Collector (2^28): 0x10000000
 105         Kagerou/Oboro  (2^29): 0x20000000
 106         Rebellion      (2^30): 0x40000000
 107         Summoner       (2^31): 0x80000000
 108
 109         Novice + Swordman + Magician + Archer = 0x0000000F, why?
 110         Because: 10 = A, 11 = B, 12 = C, 13 = D, 14 = E, and 15 = F
 111         It's using hexadecimal.
 112
 113 ---------------------------------------
 114
 115 Class: Equippable upper-types. Uses the following bitmasks:
 116          1: Normal classes (no Baby/Transcendent/Third classes)
 117          2: Transcedent classes (no Transcedent-Third classes)
 118          4: Baby classes (no Third-Baby classes)
 119          8: Third classes (no Transcedent-Third or Third-Baby classes)
 120         16: Transcedent-Third classes
 121         32: Third-Baby classes
 122
 123 ---------------------------------------
 124
 125 Gender: Gender restriction. 0 is female, 1 is male, 2 for both.
 126
 127 ---------------------------------------
 128
 129 Loc: Equipment's placement. Values are:
 130         2^8      256 = Upper Headgear
 131         2^9      512 = Middle Headgear
 132         2^0      001 = Lower Headgear
 133         2^4      016 = Armor
 134         2^1      002 = Weapon
 135         2^5      032 = Shield
 136         2^2      004 = Garment
 137         2^6      064 = Footgear
 138         2^3      008 = Accessory Right
 139         2^7      128 = Accessory Left
 140         2^10    1024 = Costume Top Headgear
 141         2^11    2048 = Costume Mid Headgear
 142         2^12    4096 = Costume Low Headgear
 143         2^13    8192 = Costume Garment/Robe
 144         2^15   32768 = Ammo
 145         2^16   65536 = Shadow Armor
 146         2^17  131072 = Shadow Weapon
 147         2^18  262144 = Shadow Shield
 148         2^19  524288 = Shadow Shoes
 149         2^20 1048576 = Shadow Accessory Right (Earring)
 150         2^21 2097152 = Shadow Accessory Left (Pendant)
 151
 152 ---------------------------------------
 153
 154 wLV: Weapon level.
 155
 156 ---------------------------------------
 157
 158 eLV: Base level required to be able to equip.
 159
 160 maxLevel: Only able to equip if base level is lower than this.
 161
 162 ---------------------------------------
 163
 164 Refineable: 1 if the item can be refined, 0 otherwise.
 165
 166 ---------------------------------------
 167
 168 View: For normal items, defines a replacement view-sprite for the item (eg:
 169       Making apples look like apple juice). The special case are weapons
 170       and ammo where this value indicates the weapon-class of the item.
 171
 172         For weapons, the types are:
 173                 0: bare fist
 174                 1: Daggers
 175                 2: One-handed swords
 176                 3: Two-handed swords
 177                 4: One-handed spears
 178                 5: Two-handed spears
 179                 6: One-handed axes
 180                 7: Two-handed axes
 181                 8: Maces
 182                 9: Unused
 183                 10: Staves
 184                 11: Bows
 185                 12: Knuckles
 186                 13: Musical Instruments
 187                 14: Whips
 188                 15: Books
 189                 16: Katars
 190                 17: Revolvers
 191                 18: Rifles
 192                 19: Gatling guns
 193                 20: Shotguns
 194                 21: Grenade launchers
 195                 22: Fuuma Shurikens
 196                 23: Two-handed staves
 197                 24: Max Type
 198                 25: Dual-wield Daggers
 199                 26: Dual-wield Swords
 200                 27: Dual-wield Axes
 201                 28: Dagger + Sword
 202                 29: Dagger + Axe
 203                 30: Sword + Axe
 204
 205         For ammo, the types are:
 206                 1: Arrows
 207                 2: Throwable daggers
 208                 3: Bullets
 209                 4: Shells
 210                 5: Grenades
 211                 6: Shuriken
 212                 7: Kunai
 213                 8: Cannonballs
 214                 9: Throwable Items (Sling Item)
 215
 216 ---------------------------------------
 217
 218 Script: Script to execute when the item is used/equipped.
 219
 220 ---------------------------------------
 221
 222 OnEquip_Script: Script to execute when the item is equipped.
 223                 Warning, not all item bonuses will work here as expected.
 224
 225 ---------------------------------------
 226
 227 OnUnequip_Script: Script to execute when the item is unequipped
 228                   or when a rental item expires.
 229                   Warning, not all item bonuses will work here as expected.
 230
 231 ---------------------------------------