DSP Wiki - User contributions [en]

Items

2013-04-04T22:49:18Z

Deviltti: /* item_basic */

==item_basic==

Stores basic item information that is common to all items. For an item to exist, it must have an entry in this table.

'''item_id''' should match what is found in POLUtils or on ffxiah.com

'''name''' is the long name of an item, such as flask_of_echo_drops. If you're scripting a file, this is the file name you should use - from Log Name (Singular) field.

'''sortname''' is the shortened name, such as echo_drops - from Name field.

'''stackSize''' determines if an item should stack, and how many should stack. The client acts a bit odd if you stack items that aren't supposed to be stacked, but generally will let you stack things like Frozen Giant Skulls if you want to improve the Dynamis experience, for example.

'''flags''' stored as a bitmask. Add values together.
{|class="wikitable sortable zebra"
!Value!!Flag
|-
|1||wall handling
|-
|-
|16||delivery inner
|-
|-
|32||inscribable
|-
|-
|64||no auction
|-
|-
|128||scroll
|-
|-
|256||unknown
|-
|-
|512||can use
|-
|-
|1024||can trade npc
|-
|-
|2048||can equip
|-
|-
|4096||no sale
|-
|-
|8192||no delivery
|-
|-
|16384||ex
|-
|-
|32768||rare
|-
|}

'''aH''' is the auction house category for the item.
Weapons
Hand to Hand 1
Daggers 2
Swords 3
Great Swords 4
Axes 5
Great Axes 6
Scythes 7
Polearms 8
Katana 9
Great Katana 10
Clubs 11
Staves 12
Ranged 13
Instruments 14
Ammo&Misc
Pet Items 48
Fishing Gear 47
Ammunition 15
Grips 62
Armor
Shields 16
Head 17
Neck 22
Body 18
Hands 19
Waist 23
Legs 20
Feet 21
Back 26
Earrings 24
Rings 25
Scrolls
White Magic 28
Black Magic 29
Songs 32
Ninjutsu 31
Summoning 30
Dice 60
Medicines 33
Furnishings 34
Materials
Alchemy 44
Woodworking 43
Bonecraft 42
Leathercraft 41
Clothcraft 40
Goldsmithing 39
Smithing 38
Food
Meals
Meat & Eggs 52
Seafood 53
Vegetables 54
Soups 55
Breads & Rice 56
Sweets 57
Drinks 58
Ingredients 59
Fish 51
Crystals 35
Others
Misc 46
Beast-Made 50
Cards 36
Ninja Tools 49
Cursed Items 37
Automatons 61

'''NoSale''' determines if the item can be sold.

'''BaseSell''' is the value of the item when selling to an NPC, before fame modifier.

==item_armor==

Stores information regarding anything that can be worn; armor, accessory, and weapons, too.

'''itemId''' matches what is found in item_basic.

'''name''' needs to be investigated. Just for readability's sake?

'''level''' is what level the item can be equipped at.

'''jobs''' determines what jobs can equip the item, stored as a bitmask. Simply add the values together to set the jobs. WAR (1) + PLD (64) + DRK (128) = 193

{|class="wikitable sortable zebra"
!Value!!Job
|-
|1||warrior
|-
|-
|2||monk
|-
|-
|4||white mage
|-
|-
|8||black mage
|-
|-
|16||red mage
|-
|-
|32||thief
|-
|-
|64||paladin
|-
|-
|128||dark knight
|-
|-
|256||beastmaster
|-
|-
|512||bard
|-
|-
|1024||ranger
|-
|-
|2048||samurai
|-
|-
|4096||ninja
|-
|-
|8192||dragoon
|-
|-
|16384||summoner
|-
|-
|32768||blue mage
|-
|-
|65536||corsair
|-
|-
|131072||puppetmaster
|-
|-
|262144||dancer
|-
|-
|524288||scholar
|-
|-
|1048576||geomancer
|-
|-
|2097152||rune fencer
|-
|}

'''MId''' determines the appearance for the item. Also see [[How_to_Add_an_Item]].

'''shieldSize''' is only used by shields, and determines how much damage they block, and how much damage they'll deal with Shield Bash.

'''scriptType''' needs to be investigated.

'''slot''' determines which slot(s) the item can be worn in, in a bitmask. main hand (1) + off hand (2) = 3.

{|class="wikitable sortable zebra"
!Value!!Valid Slot
|-
|1||main
|-
|-
|2||sub
|-
|-
|4||range
|-
|-
|8||ammo
|-
|-
|16||head
|-
|-
|32||body
|-
|-
|64||hands
|-
|-
|128||legs
|-
|-
|256||feet
|-
|-
|512||neck
|-
|-
|1024||waist
|-
|-
|2048||ear1
|-
|-
|4096||ear2
|-
|-
|8192||ring1
|-
|-
|16384||ring2
|-
|-
|32768||back
|-
|}

'''rslot''' determines which single slot cannot be used while the item is equipped. For example, Vermillion Cloak would reserve the head slot, since head equipment cannot be used with it. This is '''not''' a bitmask, and only one value can be specified.
{|class="wikitable sortable zebra"
!Value!!Reserved Slot
|-
|1||main
|-
|-
|2||range
|-
|-
|3||ammo
|-
|-
|4||head
|-
|-
|5||body
|-
|-
|6||hands
|-
|-
|7||legs
|-
|-
|8||feet
|-
|-
|9||neck
|-
|-
|10||waist
|-
|-
|11||ear1
|-
|-
|12||ear2
|-
|-
|13||ring1
|-
|-
|14||ring2
|-
|-
|15||back
|-
|-
|16||"SLOT_LINK" Linkshell?
|-
|}

==item_weapon==

Stores common information for all weapons.

'''itemId''' links the table to item_basic and item_armor, and should match those tables.

'''name''' is for readability's sake and the name of any script associated with the weapon.

'''skill''' determines which weapon proficiency should be used with the weapon.
{|class="wikitable sortable zebra"
!Value!!Weapon Skill Type
|-
|1||Hand-to-hand
|-
|-
|2||Dagger
|-
|-
|3||Sword
|-
|-
|4||Greatsword
|-
|-
|5||Axe
|-
|-
|6||Great Axe
|-
|-
|7||Scythe
|-
|-
|8||Polearm
|-
|-
|9||Katana
|-
|-
|10||Great Katana
|-
|-
|11||Club
|-
|-
|12||Staff
|-
|-
|25||Archery
|-
|-
|26||Marksmanship
|-
|-
|27||Throwing
|-
|}
'''subskill''' determines exclusivity between marksmanship-type weapons.
{|class="wikitable sortable zebra"
!Value!!Weapon Subskill Type
|-
|0||bolt
|-
|-
|1||gun
|-
|-
|2||cannon
|-
|}

'''dmgType''' determines the type of damage dealt by the weapon. Note that only Hand-to-hand damage will use both hands for jobs such as Monk as of r3200.
{|class="wikitable sortable zebra"
!Value!!Damage Type
|-
|0||Damage type "none"
|-
|-
|1||Piercing
|-
|-
|2||Slashing
|-
|-
|3||Blunt
|-
|-
|4||Hand-to-hand
|-
|-
|5||Crossbow
|-
|-
|6||Gun
|-
|}
'''hit''' is only used for multihit weapons such as Joyeuse or Kraken Club, and represents the maximum number of hits per round.

'''delay''' determines the delay of the weapon. Ranged Weapons and Ammunition always have -240 their displayed delay. For example, Expunger (Delay 360) is stored as 120 delay in the database.

'''dmg''' is the DMG stat for the equipment. Hand-to-hand weapons are always stored with their DMG stat +3. For example, Lizard Cesti has 5 instead of 2.

'''unlock_index''' refers to the id of the weapon in item_weapon_unlocked.

==item_mods==

Stores uncommon information, from Defense to "Enhances Dual Wield Effect."

item_mods is an unindexed table. As such, always keep in mind that it's possible to have duplicate values, which darkstar will cheerfully use without questioning them.

'''itemId''' links the table back to the item via item_basic, and should always match.

'''modId''' is what is being modified. A list of these values can be found in /scripts/globals/status.lua (listed in hexadecimal,) or in /src/map/modifier.h (listed in hexadecimal.) Remember to convert them to decimal for use in this table.

'''value''' is how much of the modifier to grant, and can be positive or negative. It's best to research any modifier you're unsure of, as some are stored and applied in unexpected ways, such as Magic Damage Taken being stored as amount/256, while Physical Damage Taken is stored as amount%.

==item_furniture==

Stores information regarding moghouse furniture.

'''itemId''' links back to item_basic, and should always match.

'''name''' may just be for readability's sake, and is the long name for the item.

'''storage''' is how much storage to grant for each item placed. The core will cap the total at 80.

'''moghancement''' needs to be researched.

'''element''' is the elemental alignment of the furniture.

'''aura''' needs to be researched (strength of effect?)

==item_usable==

Stores information regarding items that can be used. An item cannot be used unless it is in this table.

'''itemid''' links this table back to item_basic, and should match.

'''subid''' seems to primarily be used with spell scrolls, and probably just stores the spellid to be unlocked.

'''name''' may just be for readability's sake.

'''validTargets''' is a bitmask storing what the item can be used on. Being a bitmask, the values should be added for each valid target type. Self (1) + party (2) = 3.
{|class="wikitable sortable zebra"
!Value!!Valid target
|-
|1||Self
|-
|-
|2||Player in user's party
|-
|-
|4||Enemy
|-
|-
|8||Player in user's alliance
|-
|-
|16||Players outside of user's party/alliance
|-
|-
|32||Dead players
|-
|-
|64||NPCs
|-
|}

'''activation''' needs to be researched

'''animation''' determines which animation should be used with the item.

'''animation time''' needs to be researched, but probably determines how long the player can't move for the item usage to succeed.

'''maxCharges''' is the maximum number of usages.

'''useDelay''' is likely how long the item must be equipped before it can be used.

'''reuseDelay''' is likely how long must pass between item uses.

'''aoe''' is a simple binary on whether the item is AoE or not (0 = false, 1 = true.)

==item_latents==

Stores information regarding latent effects on items.

'''itemId''' links back to item_basic, and should always match.

'''modId''' is the number that represents the stat boost when active

'''value''' is the value to add to the stat when active

'''latentId''' is the ID of the latent effect conditions (see src/latent_effect.h)

'''latentParam''' is an additional parameter depending on the latentId (see src/latent_effect.h)

==item_weapon_unlocked==

Stores information related to weaponskill broken weapons.

'''Id''' the ID of the weapon. This only corresponds with a BLOB in the chars table ('''unlocked weapons''') and the entries in the char_weapon_skill_points table.

'''itemId''' is the matching itemId of the weapon from item_basic.

'''name''' is the same name used in item_basic, only useful for reading what the weapon is (and the filename of the script if it has a script)

'''skill''' is the combat skill associated with the weapon (battleentity.h). Note that guns and cannons are different from crossbows.

'''dmgType''' is the type of damage the weapon inflicts (piercing, blunt, handtohand, slashing).

'''hit''' is the number of hits of the weapon.

'''point''' is the amount of weaponskill points needed to "break" the weapon and unlock its associated latent effects.

==item_puppet==

The itemId, name, slot, and "element" of each automaton piece. As PUP isn't in use, this table may change substantially in the future.

Items

2013-04-04T22:48:26Z

Deviltti: /* item_basic */

==item_basic==

Stores basic item information that is common to all items. For an item to exist, it must have an entry in this table.

'''item_id''' should match what is found in POLUtils or on ffxiah.com

'''name''' is the long name of an item, such as flask_of_echo_drops. If you're scripting a file, this is the file name you should use - from Log Name (Singular) field.

'''sortname''' is the shortened name, such as echo_drops - from Name field.

'''stackSize''' determines if an item should stack, and how many should stack. The client acts a bit odd if you stack items that aren't supposed to be stacked, but generally will let you stack things like Frozen Giant Skulls if you want to improve the Dynamis experience, for example.

'''flags''' bitmask
{|class="wikitable sortable zebra"
!Value!!Flag
|-
|1||wall handling
|-
|-
|16||delivery inner
|-
|-
|32||inscribable
|-
|-
|64||no auction
|-
|-
|128||scroll
|-
|-
|256||unknown
|-
|-
|512||can use
|-
|-
|1024||can trade npc
|-
|-
|2048||can equip
|-
|-
|4096||no sale
|-
|-
|8192||no delivery
|-
|-
|16384||ex
|-
|-
|32768||rare
|-
|}

'''aH''' is the auction house category for the item.
Weapons
Hand to Hand 1
Daggers 2
Swords 3
Great Swords 4
Axes 5
Great Axes 6
Scythes 7
Polearms 8
Katana 9
Great Katana 10
Clubs 11
Staves 12
Ranged 13
Instruments 14
Ammo&Misc
Pet Items 48
Fishing Gear 47
Ammunition 15
Grips 62
Armor
Shields 16
Head 17
Neck 22
Body 18
Hands 19
Waist 23
Legs 20
Feet 21
Back 26
Earrings 24
Rings 25
Scrolls
White Magic 28
Black Magic 29
Songs 32
Ninjutsu 31
Summoning 30
Dice 60
Medicines 33
Furnishings 34
Materials
Alchemy 44
Woodworking 43
Bonecraft 42
Leathercraft 41
Clothcraft 40
Goldsmithing 39
Smithing 38
Food
Meals
Meat & Eggs 52
Seafood 53
Vegetables 54
Soups 55
Breads & Rice 56
Sweets 57
Drinks 58
Ingredients 59
Fish 51
Crystals 35
Others
Misc 46
Beast-Made 50
Cards 36
Ninja Tools 49
Cursed Items 37
Automatons 61

'''NoSale''' determines if the item can be sold.

'''BaseSell''' is the value of the item when selling to an NPC, before fame modifier.

==item_armor==

Stores information regarding anything that can be worn; armor, accessory, and weapons, too.

'''itemId''' matches what is found in item_basic.

'''name''' needs to be investigated. Just for readability's sake?

'''level''' is what level the item can be equipped at.

'''jobs''' determines what jobs can equip the item, stored as a bitmask. Simply add the values together to set the jobs. WAR (1) + PLD (64) + DRK (128) = 193

{|class="wikitable sortable zebra"
!Value!!Job
|-
|1||warrior
|-
|-
|2||monk
|-
|-
|4||white mage
|-
|-
|8||black mage
|-
|-
|16||red mage
|-
|-
|32||thief
|-
|-
|64||paladin
|-
|-
|128||dark knight
|-
|-
|256||beastmaster
|-
|-
|512||bard
|-
|-
|1024||ranger
|-
|-
|2048||samurai
|-
|-
|4096||ninja
|-
|-
|8192||dragoon
|-
|-
|16384||summoner
|-
|-
|32768||blue mage
|-
|-
|65536||corsair
|-
|-
|131072||puppetmaster
|-
|-
|262144||dancer
|-
|-
|524288||scholar
|-
|-
|1048576||geomancer
|-
|-
|2097152||rune fencer
|-
|}

'''MId''' determines the appearance for the item. Also see [[How_to_Add_an_Item]].

'''shieldSize''' is only used by shields, and determines how much damage they block, and how much damage they'll deal with Shield Bash.

'''scriptType''' needs to be investigated.

'''slot''' determines which slot(s) the item can be worn in, in a bitmask. main hand (1) + off hand (2) = 3.

{|class="wikitable sortable zebra"
!Value!!Valid Slot
|-
|1||main
|-
|-
|2||sub
|-
|-
|4||range
|-
|-
|8||ammo
|-
|-
|16||head
|-
|-
|32||body
|-
|-
|64||hands
|-
|-
|128||legs
|-
|-
|256||feet
|-
|-
|512||neck
|-
|-
|1024||waist
|-
|-
|2048||ear1
|-
|-
|4096||ear2
|-
|-
|8192||ring1
|-
|-
|16384||ring2
|-
|-
|32768||back
|-
|}

'''rslot''' determines which single slot cannot be used while the item is equipped. For example, Vermillion Cloak would reserve the head slot, since head equipment cannot be used with it. This is '''not''' a bitmask, and only one value can be specified.
{|class="wikitable sortable zebra"
!Value!!Reserved Slot
|-
|1||main
|-
|-
|2||range
|-
|-
|3||ammo
|-
|-
|4||head
|-
|-
|5||body
|-
|-
|6||hands
|-
|-
|7||legs
|-
|-
|8||feet
|-
|-
|9||neck
|-
|-
|10||waist
|-
|-
|11||ear1
|-
|-
|12||ear2
|-
|-
|13||ring1
|-
|-
|14||ring2
|-
|-
|15||back
|-
|-
|16||"SLOT_LINK" Linkshell?
|-
|}

==item_weapon==

Stores common information for all weapons.

'''itemId''' links the table to item_basic and item_armor, and should match those tables.

'''name''' is for readability's sake and the name of any script associated with the weapon.

'''skill''' determines which weapon proficiency should be used with the weapon.
{|class="wikitable sortable zebra"
!Value!!Weapon Skill Type
|-
|1||Hand-to-hand
|-
|-
|2||Dagger
|-
|-
|3||Sword
|-
|-
|4||Greatsword
|-
|-
|5||Axe
|-
|-
|6||Great Axe
|-
|-
|7||Scythe
|-
|-
|8||Polearm
|-
|-
|9||Katana
|-
|-
|10||Great Katana
|-
|-
|11||Club
|-
|-
|12||Staff
|-
|-
|25||Archery
|-
|-
|26||Marksmanship
|-
|-
|27||Throwing
|-
|}
'''subskill''' determines exclusivity between marksmanship-type weapons.
{|class="wikitable sortable zebra"
!Value!!Weapon Subskill Type
|-
|0||bolt
|-
|-
|1||gun
|-
|-
|2||cannon
|-
|}

'''dmgType''' determines the type of damage dealt by the weapon. Note that only Hand-to-hand damage will use both hands for jobs such as Monk as of r3200.
{|class="wikitable sortable zebra"
!Value!!Damage Type
|-
|0||Damage type "none"
|-
|-
|1||Piercing
|-
|-
|2||Slashing
|-
|-
|3||Blunt
|-
|-
|4||Hand-to-hand
|-
|-
|5||Crossbow
|-
|-
|6||Gun
|-
|}
'''hit''' is only used for multihit weapons such as Joyeuse or Kraken Club, and represents the maximum number of hits per round.

'''delay''' determines the delay of the weapon. Ranged Weapons and Ammunition always have -240 their displayed delay. For example, Expunger (Delay 360) is stored as 120 delay in the database.

'''dmg''' is the DMG stat for the equipment. Hand-to-hand weapons are always stored with their DMG stat +3. For example, Lizard Cesti has 5 instead of 2.

'''unlock_index''' refers to the id of the weapon in item_weapon_unlocked.

==item_mods==

Stores uncommon information, from Defense to "Enhances Dual Wield Effect."

item_mods is an unindexed table. As such, always keep in mind that it's possible to have duplicate values, which darkstar will cheerfully use without questioning them.

'''itemId''' links the table back to the item via item_basic, and should always match.

'''modId''' is what is being modified. A list of these values can be found in /scripts/globals/status.lua (listed in hexadecimal,) or in /src/map/modifier.h (listed in hexadecimal.) Remember to convert them to decimal for use in this table.

'''value''' is how much of the modifier to grant, and can be positive or negative. It's best to research any modifier you're unsure of, as some are stored and applied in unexpected ways, such as Magic Damage Taken being stored as amount/256, while Physical Damage Taken is stored as amount%.

==item_furniture==

Stores information regarding moghouse furniture.

'''itemId''' links back to item_basic, and should always match.

'''name''' may just be for readability's sake, and is the long name for the item.

'''storage''' is how much storage to grant for each item placed. The core will cap the total at 80.

'''moghancement''' needs to be researched.

'''element''' is the elemental alignment of the furniture.

'''aura''' needs to be researched (strength of effect?)

==item_usable==

Stores information regarding items that can be used. An item cannot be used unless it is in this table.

'''itemid''' links this table back to item_basic, and should match.

'''subid''' seems to primarily be used with spell scrolls, and probably just stores the spellid to be unlocked.

'''name''' may just be for readability's sake.

'''validTargets''' is a bitmask storing what the item can be used on. Being a bitmask, the values should be added for each valid target type. Self (1) + party (2) = 3.
{|class="wikitable sortable zebra"
!Value!!Valid target
|-
|1||Self
|-
|-
|2||Player in user's party
|-
|-
|4||Enemy
|-
|-
|8||Player in user's alliance
|-
|-
|16||Players outside of user's party/alliance
|-
|-
|32||Dead players
|-
|-
|64||NPCs
|-
|}

'''activation''' needs to be researched

'''animation''' determines which animation should be used with the item.

'''animation time''' needs to be researched, but probably determines how long the player can't move for the item usage to succeed.

'''maxCharges''' is the maximum number of usages.

'''useDelay''' is likely how long the item must be equipped before it can be used.

'''reuseDelay''' is likely how long must pass between item uses.

'''aoe''' is a simple binary on whether the item is AoE or not (0 = false, 1 = true.)

==item_latents==

Stores information regarding latent effects on items.

'''itemId''' links back to item_basic, and should always match.

'''modId''' is the number that represents the stat boost when active

'''value''' is the value to add to the stat when active

'''latentId''' is the ID of the latent effect conditions (see src/latent_effect.h)

'''latentParam''' is an additional parameter depending on the latentId (see src/latent_effect.h)

==item_weapon_unlocked==

Stores information related to weaponskill broken weapons.

'''Id''' the ID of the weapon. This only corresponds with a BLOB in the chars table ('''unlocked weapons''') and the entries in the char_weapon_skill_points table.

'''itemId''' is the matching itemId of the weapon from item_basic.

'''name''' is the same name used in item_basic, only useful for reading what the weapon is (and the filename of the script if it has a script)

'''skill''' is the combat skill associated with the weapon (battleentity.h). Note that guns and cannons are different from crossbows.

'''dmgType''' is the type of damage the weapon inflicts (piercing, blunt, handtohand, slashing).

'''hit''' is the number of hits of the weapon.

'''point''' is the amount of weaponskill points needed to "break" the weapon and unlock its associated latent effects.

==item_puppet==

The itemId, name, slot, and "element" of each automaton piece. As PUP isn't in use, this table may change substantially in the future.

Items

2013-04-04T22:37:12Z

Deviltti: /* item_basic */

==item_basic==

Stores basic item information that is common to all items. For an item to exist, it must have an entry in this table.

'''item_id''' should match what is found in POLUtils or on ffxiah.com

'''name''' is the long name of an item, such as flask_of_echo_drops. If you're scripting a file, this is the file name you should use.

'''sortname''' is the shortened name, such as echo_drops.

'''stackSize''' determines if an item should stack, and how many should stack. The client acts a bit odd if you stack items that aren't supposed to be stacked, but generally will let you stack things like Frozen Giant Skulls if you want to improve the Dynamis experience, for example.

'''flags''' bitmask
{|class="wikitable sortable zebra"
!Value!!Flag
|-
|1||wall handling
|-
|-
|16||delivery inner
|-
|-
|32||inscribable
|-
|-
|64||no auction
|-
|-
|128||scroll
|-
|-
|256||unknown
|-
|-
|512||can use
|-
|-
|1024||can trade npc
|-
|-
|2048||can equip
|-
|-
|4096||no sale
|-
|-
|8192||no delivery
|-
|-
|16384||ex
|-
|-
|32768||rare
|-
|}

'''aH''' is the auction house category for the item.
Weapons
Hand to Hand 1
Daggers 2
Swords 3
Great Swords 4
Axes 5
Great Axes 6
Scythes 7
Polearms 8
Katana 9
Great Katana 10
Clubs 11
Staves 12
Ranged 13
Instruments 14
Ammo&Misc
Pet Items 48
Fishing Gear 47
Ammunition 15
Grips 62
Armor
Shields 16
Head 17
Neck 22
Body 18
Hands 19
Waist 23
Legs 20
Feet 21
Back 26
Earrings 24
Rings 25
Scrolls
White Magic 28
Black Magic 29
Songs 32
Ninjutsu 31
Summoning 30
Dice 60
Medicines 33
Furnishings 34
Materials
Alchemy 44
Woodworking 43
Bonecraft 42
Leathercraft 41
Clothcraft 40
Goldsmithing 39
Smithing 38
Food
Meals
Meat & Eggs 52
Seafood 53
Vegetables 54
Soups 55
Breads & Rice 56
Sweets 57
Drinks 58
Ingredients 59
Fish 51
Crystals 35
Others
Misc 46
Beast-Made 50
Cards 36
Ninja Tools 49
Cursed Items 37
Automatons 61

'''NoSale''' determines if the item can be sold.

'''BaseSell''' is the value of the item when selling to an NPC, before fame modifier.

==item_armor==

Stores information regarding anything that can be worn; armor, accessory, and weapons, too.

'''itemId''' matches what is found in item_basic.

'''name''' needs to be investigated. Just for readability's sake?

'''level''' is what level the item can be equipped at.

'''jobs''' determines what jobs can equip the item, stored as a bitmask. Simply add the values together to set the jobs. WAR (1) + PLD (64) + DRK (128) = 193

{|class="wikitable sortable zebra"
!Value!!Job
|-
|1||warrior
|-
|-
|2||monk
|-
|-
|4||white mage
|-
|-
|8||black mage
|-
|-
|16||red mage
|-
|-
|32||thief
|-
|-
|64||paladin
|-
|-
|128||dark knight
|-
|-
|256||beastmaster
|-
|-
|512||bard
|-
|-
|1024||ranger
|-
|-
|2048||samurai
|-
|-
|4096||ninja
|-
|-
|8192||dragoon
|-
|-
|16384||summoner
|-
|-
|32768||blue mage
|-
|-
|65536||corsair
|-
|-
|131072||puppetmaster
|-
|-
|262144||dancer
|-
|-
|524288||scholar
|-
|-
|1048576||geomancer
|-
|-
|2097152||rune fencer
|-
|}

'''MId''' determines the appearance for the item. Also see [[How_to_Add_an_Item]].

'''shieldSize''' is only used by shields, and determines how much damage they block, and how much damage they'll deal with Shield Bash.

'''scriptType''' needs to be investigated.

'''slot''' determines which slot(s) the item can be worn in, in a bitmask. main hand (1) + off hand (2) = 3.

{|class="wikitable sortable zebra"
!Value!!Valid Slot
|-
|1||main
|-
|-
|2||sub
|-
|-
|4||range
|-
|-
|8||ammo
|-
|-
|16||head
|-
|-
|32||body
|-
|-
|64||hands
|-
|-
|128||legs
|-
|-
|256||feet
|-
|-
|512||neck
|-
|-
|1024||waist
|-
|-
|2048||ear1
|-
|-
|4096||ear2
|-
|-
|8192||ring1
|-
|-
|16384||ring2
|-
|-
|32768||back
|-
|}

'''rslot''' determines which single slot cannot be used while the item is equipped. For example, Vermillion Cloak would reserve the head slot, since head equipment cannot be used with it. This is '''not''' a bitmask, and only one value can be specified.
{|class="wikitable sortable zebra"
!Value!!Reserved Slot
|-
|1||main
|-
|-
|2||range
|-
|-
|3||ammo
|-
|-
|4||head
|-
|-
|5||body
|-
|-
|6||hands
|-
|-
|7||legs
|-
|-
|8||feet
|-
|-
|9||neck
|-
|-
|10||waist
|-
|-
|11||ear1
|-
|-
|12||ear2
|-
|-
|13||ring1
|-
|-
|14||ring2
|-
|-
|15||back
|-
|-
|16||"SLOT_LINK" Linkshell?
|-
|}

==item_weapon==

Stores common information for all weapons.

'''itemId''' links the table to item_basic and item_armor, and should match those tables.

'''name''' is for readability's sake and the name of any script associated with the weapon.

'''skill''' determines which weapon proficiency should be used with the weapon.
{|class="wikitable sortable zebra"
!Value!!Weapon Skill Type
|-
|1||Hand-to-hand
|-
|-
|2||Dagger
|-
|-
|3||Sword
|-
|-
|4||Greatsword
|-
|-
|5||Axe
|-
|-
|6||Great Axe
|-
|-
|7||Scythe
|-
|-
|8||Polearm
|-
|-
|9||Katana
|-
|-
|10||Great Katana
|-
|-
|11||Club
|-
|-
|12||Staff
|-
|-
|25||Archery
|-
|-
|26||Marksmanship
|-
|-
|27||Throwing
|-
|}
'''subskill''' determines exclusivity between marksmanship-type weapons.
{|class="wikitable sortable zebra"
!Value!!Weapon Subskill Type
|-
|0||bolt
|-
|-
|1||gun
|-
|-
|2||cannon
|-
|}

'''dmgType''' determines the type of damage dealt by the weapon. Note that only Hand-to-hand damage will use both hands for jobs such as Monk as of r3200.
{|class="wikitable sortable zebra"
!Value!!Damage Type
|-
|0||Damage type "none"
|-
|-
|1||Piercing
|-
|-
|2||Slashing
|-
|-
|3||Blunt
|-
|-
|4||Hand-to-hand
|-
|-
|5||Crossbow
|-
|-
|6||Gun
|-
|}
'''hit''' is only used for multihit weapons such as Joyeuse or Kraken Club, and represents the maximum number of hits per round.

'''delay''' determines the delay of the weapon. Ranged Weapons and Ammunition always have -240 their displayed delay. For example, Expunger (Delay 360) is stored as 120 delay in the database.

'''dmg''' is the DMG stat for the equipment. Hand-to-hand weapons are always stored with their DMG stat +3. For example, Lizard Cesti has 5 instead of 2.

'''unlock_index''' refers to the id of the weapon in item_weapon_unlocked.

==item_mods==

Stores uncommon information, from Defense to "Enhances Dual Wield Effect."

item_mods is an unindexed table. As such, always keep in mind that it's possible to have duplicate values, which darkstar will cheerfully use without questioning them.

'''itemId''' links the table back to the item via item_basic, and should always match.

'''modId''' is what is being modified. A list of these values can be found in /scripts/globals/status.lua (listed in hexadecimal,) or in /src/map/modifier.h (listed in hexadecimal.) Remember to convert them to decimal for use in this table.

'''value''' is how much of the modifier to grant, and can be positive or negative. It's best to research any modifier you're unsure of, as some are stored and applied in unexpected ways, such as Magic Damage Taken being stored as amount/256, while Physical Damage Taken is stored as amount%.

==item_furniture==

Stores information regarding moghouse furniture.

'''itemId''' links back to item_basic, and should always match.

'''name''' may just be for readability's sake, and is the long name for the item.

'''storage''' is how much storage to grant for each item placed. The core will cap the total at 80.

'''moghancement''' needs to be researched.

'''element''' is the elemental alignment of the furniture.

'''aura''' needs to be researched (strength of effect?)

==item_usable==

Stores information regarding items that can be used. An item cannot be used unless it is in this table.

'''itemid''' links this table back to item_basic, and should match.

'''subid''' seems to primarily be used with spell scrolls, and probably just stores the spellid to be unlocked.

'''name''' may just be for readability's sake.

'''validTargets''' is a bitmask storing what the item can be used on. Being a bitmask, the values should be added for each valid target type. Self (1) + party (2) = 3.
{|class="wikitable sortable zebra"
!Value!!Valid target
|-
|1||Self
|-
|-
|2||Player in user's party
|-
|-
|4||Enemy
|-
|-
|8||Player in user's alliance
|-
|-
|16||Players outside of user's party/alliance
|-
|-
|32||Dead players
|-
|-
|64||NPCs
|-
|}

'''activation''' needs to be researched

'''animation''' determines which animation should be used with the item.

'''animation time''' needs to be researched, but probably determines how long the player can't move for the item usage to succeed.

'''maxCharges''' is the maximum number of usages.

'''useDelay''' is likely how long the item must be equipped before it can be used.

'''reuseDelay''' is likely how long must pass between item uses.

'''aoe''' is a simple binary on whether the item is AoE or not (0 = false, 1 = true.)

==item_latents==

Stores information regarding latent effects on items.

'''itemId''' links back to item_basic, and should always match.

'''modId''' is the number that represents the stat boost when active

'''value''' is the value to add to the stat when active

'''latentId''' is the ID of the latent effect conditions (see src/latent_effect.h)

'''latentParam''' is an additional parameter depending on the latentId (see src/latent_effect.h)

==item_weapon_unlocked==

Stores information related to weaponskill broken weapons.

'''Id''' the ID of the weapon. This only corresponds with a BLOB in the chars table ('''unlocked weapons''') and the entries in the char_weapon_skill_points table.

'''itemId''' is the matching itemId of the weapon from item_basic.

'''name''' is the same name used in item_basic, only useful for reading what the weapon is (and the filename of the script if it has a script)

'''skill''' is the combat skill associated with the weapon (battleentity.h). Note that guns and cannons are different from crossbows.

'''dmgType''' is the type of damage the weapon inflicts (piercing, blunt, handtohand, slashing).

'''hit''' is the number of hits of the weapon.

'''point''' is the amount of weaponskill points needed to "break" the weapon and unlock its associated latent effects.

==item_puppet==

The itemId, name, slot, and "element" of each automaton piece. As PUP isn't in use, this table may change substantially in the future.

Items

2013-04-04T22:36:03Z

Deviltti: /* item_basic */

==item_basic==

Stores basic item information that is common to all items. For an item to exist, it must have an entry in this table.

'''item_id''' should match what is found in POLUtils or on ffxiah.com

'''name''' is the long name of an item, such as flask_of_echo_drops. If you're scripting a file, this is the file name you should use.

'''sortname''' is the shortened name, such as echo_drops.

'''stackSize''' determines if an item should stack, and how many should stack. The client acts a bit odd if you stack items that aren't supposed to be stacked, but generally will let you stack things like Frozen Giant Skulls if you want to improve the Dynamis experience, for example.

'''flags''' Bitmask
{|class="wikitable sortable zebra"
!Value!!Flag
|-
|1||wall handling
|-
|-
|16||delivery inner
|-
|-
|32||inscribable
|-
|-
|64||no auction
|-
|-
|128||scroll
|-
|-
|256||unknown
|-
|-
|512||can use
|-
|-
|1024||can trade npc
|-
|-
|2048||can equip
|-
|-
|4096||no sale
|-
|-
|8192||no delivery
|-
|-
|16384||ex
|-
|-
|32768||rare
|-
|}

'''aH''' is the auction house category for the item.
{|class="wikitable sortable zebra"
!Value!!Auction House Category
|-
|||weapons
|-
|-
|1||hand to hand
|-
|-
|32||inscribable
|-
|-
|64||no auction
|-
|-
|128||scroll
|-
|-
|256||unknown
|-
|-
|512||can use
|-
|-
|1024||can trade npc
|-
|-
|2048||can equip
|-
|-
|4096||no sale
|-
|-
|8192||no delivery
|-
|-
|16384||ex
|-
|-
|32768||rare
|-
|}

'''NoSale''' determines if the item can be sold.

'''BaseSell''' is the value of the item when selling to an NPC, before fame modifier.

==item_armor==

Stores information regarding anything that can be worn; armor, accessory, and weapons, too.

'''itemId''' matches what is found in item_basic.

'''name''' needs to be investigated. Just for readability's sake?

'''level''' is what level the item can be equipped at.

'''jobs''' determines what jobs can equip the item, stored as a bitmask. Simply add the values together to set the jobs. WAR (1) + PLD (64) + DRK (128) = 193

{|class="wikitable sortable zebra"
!Value!!Job
|-
|1||warrior
|-
|-
|2||monk
|-
|-
|4||white mage
|-
|-
|8||black mage
|-
|-
|16||red mage
|-
|-
|32||thief
|-
|-
|64||paladin
|-
|-
|128||dark knight
|-
|-
|256||beastmaster
|-
|-
|512||bard
|-
|-
|1024||ranger
|-
|-
|2048||samurai
|-
|-
|4096||ninja
|-
|-
|8192||dragoon
|-
|-
|16384||summoner
|-
|-
|32768||blue mage
|-
|-
|65536||corsair
|-
|-
|131072||puppetmaster
|-
|-
|262144||dancer
|-
|-
|524288||scholar
|-
|-
|1048576||geomancer
|-
|-
|2097152||rune fencer
|-
|}

'''MId''' determines the appearance for the item. Also see [[How_to_Add_an_Item]].

'''shieldSize''' is only used by shields, and determines how much damage they block, and how much damage they'll deal with Shield Bash.

'''scriptType''' needs to be investigated.

'''slot''' determines which slot(s) the item can be worn in, in a bitmask. main hand (1) + off hand (2) = 3.

{|class="wikitable sortable zebra"
!Value!!Valid Slot
|-
|1||main
|-
|-
|2||sub
|-
|-
|4||range
|-
|-
|8||ammo
|-
|-
|16||head
|-
|-
|32||body
|-
|-
|64||hands
|-
|-
|128||legs
|-
|-
|256||feet
|-
|-
|512||neck
|-
|-
|1024||waist
|-
|-
|2048||ear1
|-
|-
|4096||ear2
|-
|-
|8192||ring1
|-
|-
|16384||ring2
|-
|-
|32768||back
|-
|}

'''rslot''' determines which single slot cannot be used while the item is equipped. For example, Vermillion Cloak would reserve the head slot, since head equipment cannot be used with it. This is '''not''' a bitmask, and only one value can be specified.
{|class="wikitable sortable zebra"
!Value!!Reserved Slot
|-
|1||main
|-
|-
|2||range
|-
|-
|3||ammo
|-
|-
|4||head
|-
|-
|5||body
|-
|-
|6||hands
|-
|-
|7||legs
|-
|-
|8||feet
|-
|-
|9||neck
|-
|-
|10||waist
|-
|-
|11||ear1
|-
|-
|12||ear2
|-
|-
|13||ring1
|-
|-
|14||ring2
|-
|-
|15||back
|-
|-
|16||"SLOT_LINK" Linkshell?
|-
|}

==item_weapon==

Stores common information for all weapons.

'''itemId''' links the table to item_basic and item_armor, and should match those tables.

'''name''' is for readability's sake and the name of any script associated with the weapon.

'''skill''' determines which weapon proficiency should be used with the weapon.
{|class="wikitable sortable zebra"
!Value!!Weapon Skill Type
|-
|1||Hand-to-hand
|-
|-
|2||Dagger
|-
|-
|3||Sword
|-
|-
|4||Greatsword
|-
|-
|5||Axe
|-
|-
|6||Great Axe
|-
|-
|7||Scythe
|-
|-
|8||Polearm
|-
|-
|9||Katana
|-
|-
|10||Great Katana
|-
|-
|11||Club
|-
|-
|12||Staff
|-
|-
|25||Archery
|-
|-
|26||Marksmanship
|-
|-
|27||Throwing
|-
|}
'''subskill''' determines exclusivity between marksmanship-type weapons.
{|class="wikitable sortable zebra"
!Value!!Weapon Subskill Type
|-
|0||bolt
|-
|-
|1||gun
|-
|-
|2||cannon
|-
|}

'''dmgType''' determines the type of damage dealt by the weapon. Note that only Hand-to-hand damage will use both hands for jobs such as Monk as of r3200.
{|class="wikitable sortable zebra"
!Value!!Damage Type
|-
|0||Damage type "none"
|-
|-
|1||Piercing
|-
|-
|2||Slashing
|-
|-
|3||Blunt
|-
|-
|4||Hand-to-hand
|-
|-
|5||Crossbow
|-
|-
|6||Gun
|-
|}
'''hit''' is only used for multihit weapons such as Joyeuse or Kraken Club, and represents the maximum number of hits per round.

'''delay''' determines the delay of the weapon. Ranged Weapons and Ammunition always have -240 their displayed delay. For example, Expunger (Delay 360) is stored as 120 delay in the database.

'''dmg''' is the DMG stat for the equipment. Hand-to-hand weapons are always stored with their DMG stat +3. For example, Lizard Cesti has 5 instead of 2.

'''unlock_index''' refers to the id of the weapon in item_weapon_unlocked.

==item_mods==

Stores uncommon information, from Defense to "Enhances Dual Wield Effect."

item_mods is an unindexed table. As such, always keep in mind that it's possible to have duplicate values, which darkstar will cheerfully use without questioning them.

'''itemId''' links the table back to the item via item_basic, and should always match.

'''modId''' is what is being modified. A list of these values can be found in /scripts/globals/status.lua (listed in hexadecimal,) or in /src/map/modifier.h (listed in hexadecimal.) Remember to convert them to decimal for use in this table.

'''value''' is how much of the modifier to grant, and can be positive or negative. It's best to research any modifier you're unsure of, as some are stored and applied in unexpected ways, such as Magic Damage Taken being stored as amount/256, while Physical Damage Taken is stored as amount%.

==item_furniture==

Stores information regarding moghouse furniture.

'''itemId''' links back to item_basic, and should always match.

'''name''' may just be for readability's sake, and is the long name for the item.

'''storage''' is how much storage to grant for each item placed. The core will cap the total at 80.

'''moghancement''' needs to be researched.

'''element''' is the elemental alignment of the furniture.

'''aura''' needs to be researched (strength of effect?)

==item_usable==

Stores information regarding items that can be used. An item cannot be used unless it is in this table.

'''itemid''' links this table back to item_basic, and should match.

'''subid''' seems to primarily be used with spell scrolls, and probably just stores the spellid to be unlocked.

'''name''' may just be for readability's sake.

'''validTargets''' is a bitmask storing what the item can be used on. Being a bitmask, the values should be added for each valid target type. Self (1) + party (2) = 3.
{|class="wikitable sortable zebra"
!Value!!Valid target
|-
|1||Self
|-
|-
|2||Player in user's party
|-
|-
|4||Enemy
|-
|-
|8||Player in user's alliance
|-
|-
|16||Players outside of user's party/alliance
|-
|-
|32||Dead players
|-
|-
|64||NPCs
|-
|}

'''activation''' needs to be researched

'''animation''' determines which animation should be used with the item.

'''animation time''' needs to be researched, but probably determines how long the player can't move for the item usage to succeed.

'''maxCharges''' is the maximum number of usages.

'''useDelay''' is likely how long the item must be equipped before it can be used.

'''reuseDelay''' is likely how long must pass between item uses.

'''aoe''' is a simple binary on whether the item is AoE or not (0 = false, 1 = true.)

==item_latents==

Stores information regarding latent effects on items.

'''itemId''' links back to item_basic, and should always match.

'''modId''' is the number that represents the stat boost when active

'''value''' is the value to add to the stat when active

'''latentId''' is the ID of the latent effect conditions (see src/latent_effect.h)

'''latentParam''' is an additional parameter depending on the latentId (see src/latent_effect.h)

==item_weapon_unlocked==

Stores information related to weaponskill broken weapons.

'''Id''' the ID of the weapon. This only corresponds with a BLOB in the chars table ('''unlocked weapons''') and the entries in the char_weapon_skill_points table.

'''itemId''' is the matching itemId of the weapon from item_basic.

'''name''' is the same name used in item_basic, only useful for reading what the weapon is (and the filename of the script if it has a script)

'''skill''' is the combat skill associated with the weapon (battleentity.h). Note that guns and cannons are different from crossbows.

'''dmgType''' is the type of damage the weapon inflicts (piercing, blunt, handtohand, slashing).

'''hit''' is the number of hits of the weapon.

'''point''' is the amount of weaponskill points needed to "break" the weapon and unlock its associated latent effects.

==item_puppet==

The itemId, name, slot, and "element" of each automaton piece. As PUP isn't in use, this table may change substantially in the future.

Items

2013-04-04T22:13:53Z

Deviltti: /* item_weapon */

==item_basic==

Stores basic item information that is common to all items. For an item to exist, it must have an entry in this table.

'''item_id''' should match what is found in POLUtils or on ffxiah.com

'''name''' is the long name of an item, such as flask_of_echo_drops. If you're scripting a file, this is the file name you should use.

'''sortname''' is the shortened name, such as echo_drops.

'''stackSize''' determines if an item should stack, and how many should stack. The client acts a bit odd if you stack items that aren't supposed to be stacked, but generally will let you stack things like Frozen Giant Skulls if you want to improve the Dynamis experience, for example.

'''flags''' Bitmask
{|class="wikitable sortable zebra"
!Value!!Flag
|-
|1||wall handling
|-
|-
|16||delivery inner
|-
|-
|32||inscribable
|-
|-
|64||no auction
|-
|-
|128||scroll
|-
|-
|256||unknown
|-
|-
|512||can use
|-
|-
|1024||can trade npc
|-
|-
|2048||can equip
|-
|-
|4096||no sale
|-
|-
|8192||no delivery
|-
|-
|16384||ex
|-
|-
|32768||rare
|-
|}

'''aH''' is the auction house category for the item.

'''NoSale''' determines if the item can be sold.

'''BaseSell''' is the value of the item when selling to an NPC, before fame modifier.

==item_armor==

Stores information regarding anything that can be worn; armor, accessory, and weapons, too.

'''itemId''' matches what is found in item_basic.

'''name''' needs to be investigated. Just for readability's sake?

'''level''' is what level the item can be equipped at.

'''jobs''' determines what jobs can equip the item, stored as a bitmask. Simply add the values together to set the jobs. WAR (1) + PLD (64) + DRK (128) = 193

{|class="wikitable sortable zebra"
!Value!!Job
|-
|1||warrior
|-
|-
|2||monk
|-
|-
|4||white mage
|-
|-
|8||black mage
|-
|-
|16||red mage
|-
|-
|32||thief
|-
|-
|64||paladin
|-
|-
|128||dark knight
|-
|-
|256||beastmaster
|-
|-
|512||bard
|-
|-
|1024||ranger
|-
|-
|2048||samurai
|-
|-
|4096||ninja
|-
|-
|8192||dragoon
|-
|-
|16384||summoner
|-
|-
|32768||blue mage
|-
|-
|65536||corsair
|-
|-
|131072||puppetmaster
|-
|-
|262144||dancer
|-
|-
|524288||scholar
|-
|-
|1048576||geomancer
|-
|-
|2097152||rune fencer
|-
|}

'''MId''' determines the appearance for the item. Also see [[How_to_Add_an_Item]].

'''shieldSize''' is only used by shields, and determines how much damage they block, and how much damage they'll deal with Shield Bash.

'''scriptType''' needs to be investigated.

'''slot''' determines which slot(s) the item can be worn in, in a bitmask. main hand (1) + off hand (2) = 3.

{|class="wikitable sortable zebra"
!Value!!Valid Slot
|-
|1||main
|-
|-
|2||sub
|-
|-
|4||range
|-
|-
|8||ammo
|-
|-
|16||head
|-
|-
|32||body
|-
|-
|64||hands
|-
|-
|128||legs
|-
|-
|256||feet
|-
|-
|512||neck
|-
|-
|1024||waist
|-
|-
|2048||ear1
|-
|-
|4096||ear2
|-
|-
|8192||ring1
|-
|-
|16384||ring2
|-
|-
|32768||back
|-
|}

'''rslot''' determines which single slot cannot be used while the item is equipped. For example, Vermillion Cloak would reserve the head slot, since head equipment cannot be used with it. This is '''not''' a bitmask, and only one value can be specified.
{|class="wikitable sortable zebra"
!Value!!Reserved Slot
|-
|1||main
|-
|-
|2||range
|-
|-
|3||ammo
|-
|-
|4||head
|-
|-
|5||body
|-
|-
|6||hands
|-
|-
|7||legs
|-
|-
|8||feet
|-
|-
|9||neck
|-
|-
|10||waist
|-
|-
|11||ear1
|-
|-
|12||ear2
|-
|-
|13||ring1
|-
|-
|14||ring2
|-
|-
|15||back
|-
|-
|16||"SLOT_LINK" Linkshell?
|-
|}

==item_weapon==

Stores common information for all weapons.

'''itemId''' links the table to item_basic and item_armor, and should match those tables.

'''name''' is for readability's sake and the name of any script associated with the weapon.

'''skill''' determines which weapon proficiency should be used with the weapon.
{|class="wikitable sortable zebra"
!Value!!Weapon Skill Type
|-
|1||Hand-to-hand
|-
|-
|2||Dagger
|-
|-
|3||Sword
|-
|-
|4||Greatsword
|-
|-
|5||Axe
|-
|-
|6||Great Axe
|-
|-
|7||Scythe
|-
|-
|8||Polearm
|-
|-
|9||Katana
|-
|-
|10||Great Katana
|-
|-
|11||Club
|-
|-
|12||Staff
|-
|-
|25||Archery
|-
|-
|26||Marksmanship
|-
|-
|27||Throwing
|-
|}
'''subskill''' determines exclusivity between marksmanship-type weapons.
{|class="wikitable sortable zebra"
!Value!!Weapon Subskill Type
|-
|0||bolt
|-
|-
|1||gun
|-
|-
|2||cannon
|-
|}

'''dmgType''' determines the type of damage dealt by the weapon. Note that only Hand-to-hand damage will use both hands for jobs such as Monk as of r3200.
{|class="wikitable sortable zebra"
!Value!!Damage Type
|-
|0||Damage type "none"
|-
|-
|1||Piercing
|-
|-
|2||Slashing
|-
|-
|3||Blunt
|-
|-
|4||Hand-to-hand
|-
|-
|5||Crossbow
|-
|-
|6||Gun
|-
|}
'''hit''' is only used for multihit weapons such as Joyeuse or Kraken Club, and represents the maximum number of hits per round.

'''delay''' determines the delay of the weapon. Ranged Weapons and Ammunition always have -240 their displayed delay. For example, Expunger (Delay 360) is stored as 120 delay in the database.

'''dmg''' is the DMG stat for the equipment. Hand-to-hand weapons are always stored with their DMG stat +3. For example, Lizard Cesti has 5 instead of 2.

'''unlock_index''' refers to the id of the weapon in item_weapon_unlocked.

==item_mods==

Stores uncommon information, from Defense to "Enhances Dual Wield Effect."

item_mods is an unindexed table. As such, always keep in mind that it's possible to have duplicate values, which darkstar will cheerfully use without questioning them.

'''itemId''' links the table back to the item via item_basic, and should always match.

'''modId''' is what is being modified. A list of these values can be found in /scripts/globals/status.lua (listed in hexadecimal,) or in /src/map/modifier.h (listed in hexadecimal.) Remember to convert them to decimal for use in this table.

'''value''' is how much of the modifier to grant, and can be positive or negative. It's best to research any modifier you're unsure of, as some are stored and applied in unexpected ways, such as Magic Damage Taken being stored as amount/256, while Physical Damage Taken is stored as amount%.

==item_furniture==

Stores information regarding moghouse furniture.

'''itemId''' links back to item_basic, and should always match.

'''name''' may just be for readability's sake, and is the long name for the item.

'''storage''' is how much storage to grant for each item placed. The core will cap the total at 80.

'''moghancement''' needs to be researched.

'''element''' is the elemental alignment of the furniture.

'''aura''' needs to be researched (strength of effect?)

==item_usable==

Stores information regarding items that can be used. An item cannot be used unless it is in this table.

'''itemid''' links this table back to item_basic, and should match.

'''subid''' seems to primarily be used with spell scrolls, and probably just stores the spellid to be unlocked.

'''name''' may just be for readability's sake.

'''validTargets''' is a bitmask storing what the item can be used on. Being a bitmask, the values should be added for each valid target type. Self (1) + party (2) = 3.
{|class="wikitable sortable zebra"
!Value!!Valid target
|-
|1||Self
|-
|-
|2||Player in user's party
|-
|-
|4||Enemy
|-
|-
|8||Player in user's alliance
|-
|-
|16||Players outside of user's party/alliance
|-
|-
|32||Dead players
|-
|-
|64||NPCs
|-
|}

'''activation''' needs to be researched

'''animation''' determines which animation should be used with the item.

'''animation time''' needs to be researched, but probably determines how long the player can't move for the item usage to succeed.

'''maxCharges''' is the maximum number of usages.

'''useDelay''' is likely how long the item must be equipped before it can be used.

'''reuseDelay''' is likely how long must pass between item uses.

'''aoe''' is a simple binary on whether the item is AoE or not (0 = false, 1 = true.)

==item_latents==

Stores information regarding latent effects on items.

'''itemId''' links back to item_basic, and should always match.

'''modId''' is the number that represents the stat boost when active

'''value''' is the value to add to the stat when active

'''latentId''' is the ID of the latent effect conditions (see src/latent_effect.h)

'''latentParam''' is an additional parameter depending on the latentId (see src/latent_effect.h)

==item_weapon_unlocked==

Stores information related to weaponskill broken weapons.

'''Id''' the ID of the weapon. This only corresponds with a BLOB in the chars table ('''unlocked weapons''') and the entries in the char_weapon_skill_points table.

'''itemId''' is the matching itemId of the weapon from item_basic.

'''name''' is the same name used in item_basic, only useful for reading what the weapon is (and the filename of the script if it has a script)

'''skill''' is the combat skill associated with the weapon (battleentity.h). Note that guns and cannons are different from crossbows.

'''dmgType''' is the type of damage the weapon inflicts (piercing, blunt, handtohand, slashing).

'''hit''' is the number of hits of the weapon.

'''point''' is the amount of weaponskill points needed to "break" the weapon and unlock its associated latent effects.

==item_puppet==

The itemId, name, slot, and "element" of each automaton piece. As PUP isn't in use, this table may change substantially in the future.

Items

2013-04-04T22:12:50Z

Deviltti: /* item_weapon */

==item_basic==

Stores basic item information that is common to all items. For an item to exist, it must have an entry in this table.

'''item_id''' should match what is found in POLUtils or on ffxiah.com

'''name''' is the long name of an item, such as flask_of_echo_drops. If you're scripting a file, this is the file name you should use.

'''sortname''' is the shortened name, such as echo_drops.

'''stackSize''' determines if an item should stack, and how many should stack. The client acts a bit odd if you stack items that aren't supposed to be stacked, but generally will let you stack things like Frozen Giant Skulls if you want to improve the Dynamis experience, for example.

'''flags''' Bitmask
{|class="wikitable sortable zebra"
!Value!!Flag
|-
|1||wall handling
|-
|-
|16||delivery inner
|-
|-
|32||inscribable
|-
|-
|64||no auction
|-
|-
|128||scroll
|-
|-
|256||unknown
|-
|-
|512||can use
|-
|-
|1024||can trade npc
|-
|-
|2048||can equip
|-
|-
|4096||no sale
|-
|-
|8192||no delivery
|-
|-
|16384||ex
|-
|-
|32768||rare
|-
|}

'''aH''' is the auction house category for the item.

'''NoSale''' determines if the item can be sold.

'''BaseSell''' is the value of the item when selling to an NPC, before fame modifier.

==item_armor==

Stores information regarding anything that can be worn; armor, accessory, and weapons, too.

'''itemId''' matches what is found in item_basic.

'''name''' needs to be investigated. Just for readability's sake?

'''level''' is what level the item can be equipped at.

'''jobs''' determines what jobs can equip the item, stored as a bitmask. Simply add the values together to set the jobs. WAR (1) + PLD (64) + DRK (128) = 193

{|class="wikitable sortable zebra"
!Value!!Job
|-
|1||warrior
|-
|-
|2||monk
|-
|-
|4||white mage
|-
|-
|8||black mage
|-
|-
|16||red mage
|-
|-
|32||thief
|-
|-
|64||paladin
|-
|-
|128||dark knight
|-
|-
|256||beastmaster
|-
|-
|512||bard
|-
|-
|1024||ranger
|-
|-
|2048||samurai
|-
|-
|4096||ninja
|-
|-
|8192||dragoon
|-
|-
|16384||summoner
|-
|-
|32768||blue mage
|-
|-
|65536||corsair
|-
|-
|131072||puppetmaster
|-
|-
|262144||dancer
|-
|-
|524288||scholar
|-
|-
|1048576||geomancer
|-
|-
|2097152||rune fencer
|-
|}

'''MId''' determines the appearance for the item. Also see [[How_to_Add_an_Item]].

'''shieldSize''' is only used by shields, and determines how much damage they block, and how much damage they'll deal with Shield Bash.

'''scriptType''' needs to be investigated.

'''slot''' determines which slot(s) the item can be worn in, in a bitmask. main hand (1) + off hand (2) = 3.

{|class="wikitable sortable zebra"
!Value!!Valid Slot
|-
|1||main
|-
|-
|2||sub
|-
|-
|4||range
|-
|-
|8||ammo
|-
|-
|16||head
|-
|-
|32||body
|-
|-
|64||hands
|-
|-
|128||legs
|-
|-
|256||feet
|-
|-
|512||neck
|-
|-
|1024||waist
|-
|-
|2048||ear1
|-
|-
|4096||ear2
|-
|-
|8192||ring1
|-
|-
|16384||ring2
|-
|-
|32768||back
|-
|}

'''rslot''' determines which single slot cannot be used while the item is equipped. For example, Vermillion Cloak would reserve the head slot, since head equipment cannot be used with it. This is '''not''' a bitmask, and only one value can be specified.
{|class="wikitable sortable zebra"
!Value!!Reserved Slot
|-
|1||main
|-
|-
|2||range
|-
|-
|3||ammo
|-
|-
|4||head
|-
|-
|5||body
|-
|-
|6||hands
|-
|-
|7||legs
|-
|-
|8||feet
|-
|-
|9||neck
|-
|-
|10||waist
|-
|-
|11||ear1
|-
|-
|12||ear2
|-
|-
|13||ring1
|-
|-
|14||ring2
|-
|-
|15||back
|-
|-
|16||"SLOT_LINK" Linkshell?
|-
|}

==item_weapon==

Stores common information for all weapons.

'''itemId''' links the table to item_basic and item_armor, and should match those tables.

'''name''' is for readability's sake and the name of any script associated with the weapon.

'''skill''' determines which weapon proficiency should be used with the weapon.
{|class="wikitable sortable zebra"
!Value!!Weapon Type
|-
|1||Hand-to-hand
|-
|-
|2||Dagger
|-
|-
|3||Sword
|-
|-
|4||Greatsword
|-
|-
|5||Axe
|-
|-
|6||Great Axe
|-
|-
|7||Scythe
|-
|-
|8||Polearm
|-
|-
|9||Katana
|-
|-
|10||Great Katana
|-
|-
|11||Club
|-
|-
|12||Staff
|-
|-
|25||Archery
|-
|-
|26||Marksmanship
|-
|-
|27||Throwing
|-
|}
'''subskill''' determines exclusivity between marksmanship-type weapons.
{|class="wikitable sortable zebra"
!Value!!Marksmanship Subskill
|-
|0||bolt
|-
|-
|1||gun
|-
|-
|2||cannon
|-
|}

'''dmgType''' determines the type of damage dealt by the weapon. Note that only Hand-to-hand damage will use both hands for jobs such as Monk as of r3200.
{|class="wikitable sortable zebra"
!Value!!Damage Type
|-
|0||Damage type "none"
|-
|-
|1||Piercing
|-
|-
|2||Slashing
|-
|-
|3||Blunt
|-
|-
|4||Hand-to-hand
|-
|-
|5||Crossbow
|-
|-
|6||Gun
|-
|}
'''hit''' is only used for multihit weapons such as Joyeuse or Kraken Club, and represents the maximum number of hits per round.

'''delay''' determines the delay of the weapon. Ranged Weapons and Ammunition always have -240 their displayed delay. For example, Expunger (Delay 360) is stored as 120 delay in the database.

'''dmg''' is the DMG stat for the equipment. Hand-to-hand weapons are always stored with their DMG stat +3. For example, Lizard Cesti has 5 instead of 2.

'''unlock_index''' refers to the id of the weapon in item_weapon_unlocked.

==item_mods==

Stores uncommon information, from Defense to "Enhances Dual Wield Effect."

item_mods is an unindexed table. As such, always keep in mind that it's possible to have duplicate values, which darkstar will cheerfully use without questioning them.

'''itemId''' links the table back to the item via item_basic, and should always match.

'''modId''' is what is being modified. A list of these values can be found in /scripts/globals/status.lua (listed in hexadecimal,) or in /src/map/modifier.h (listed in hexadecimal.) Remember to convert them to decimal for use in this table.

'''value''' is how much of the modifier to grant, and can be positive or negative. It's best to research any modifier you're unsure of, as some are stored and applied in unexpected ways, such as Magic Damage Taken being stored as amount/256, while Physical Damage Taken is stored as amount%.

==item_furniture==

Stores information regarding moghouse furniture.

'''itemId''' links back to item_basic, and should always match.

'''name''' may just be for readability's sake, and is the long name for the item.

'''storage''' is how much storage to grant for each item placed. The core will cap the total at 80.

'''moghancement''' needs to be researched.

'''element''' is the elemental alignment of the furniture.

'''aura''' needs to be researched (strength of effect?)

==item_usable==

Stores information regarding items that can be used. An item cannot be used unless it is in this table.

'''itemid''' links this table back to item_basic, and should match.

'''subid''' seems to primarily be used with spell scrolls, and probably just stores the spellid to be unlocked.

'''name''' may just be for readability's sake.

'''validTargets''' is a bitmask storing what the item can be used on. Being a bitmask, the values should be added for each valid target type. Self (1) + party (2) = 3.
{|class="wikitable sortable zebra"
!Value!!Valid target
|-
|1||Self
|-
|-
|2||Player in user's party
|-
|-
|4||Enemy
|-
|-
|8||Player in user's alliance
|-
|-
|16||Players outside of user's party/alliance
|-
|-
|32||Dead players
|-
|-
|64||NPCs
|-
|}

'''activation''' needs to be researched

'''animation''' determines which animation should be used with the item.

'''animation time''' needs to be researched, but probably determines how long the player can't move for the item usage to succeed.

'''maxCharges''' is the maximum number of usages.

'''useDelay''' is likely how long the item must be equipped before it can be used.

'''reuseDelay''' is likely how long must pass between item uses.

'''aoe''' is a simple binary on whether the item is AoE or not (0 = false, 1 = true.)

==item_latents==

Stores information regarding latent effects on items.

'''itemId''' links back to item_basic, and should always match.

'''modId''' is the number that represents the stat boost when active

'''value''' is the value to add to the stat when active

'''latentId''' is the ID of the latent effect conditions (see src/latent_effect.h)

'''latentParam''' is an additional parameter depending on the latentId (see src/latent_effect.h)

==item_weapon_unlocked==

Stores information related to weaponskill broken weapons.

'''Id''' the ID of the weapon. This only corresponds with a BLOB in the chars table ('''unlocked weapons''') and the entries in the char_weapon_skill_points table.

'''itemId''' is the matching itemId of the weapon from item_basic.

'''name''' is the same name used in item_basic, only useful for reading what the weapon is (and the filename of the script if it has a script)

'''skill''' is the combat skill associated with the weapon (battleentity.h). Note that guns and cannons are different from crossbows.

'''dmgType''' is the type of damage the weapon inflicts (piercing, blunt, handtohand, slashing).

'''hit''' is the number of hits of the weapon.

'''point''' is the amount of weaponskill points needed to "break" the weapon and unlock its associated latent effects.

==item_puppet==

The itemId, name, slot, and "element" of each automaton piece. As PUP isn't in use, this table may change substantially in the future.

Items

2013-04-04T22:12:12Z

Deviltti: /* item_weapon */

==item_basic==

Stores basic item information that is common to all items. For an item to exist, it must have an entry in this table.

'''item_id''' should match what is found in POLUtils or on ffxiah.com

'''name''' is the long name of an item, such as flask_of_echo_drops. If you're scripting a file, this is the file name you should use.

'''sortname''' is the shortened name, such as echo_drops.

'''stackSize''' determines if an item should stack, and how many should stack. The client acts a bit odd if you stack items that aren't supposed to be stacked, but generally will let you stack things like Frozen Giant Skulls if you want to improve the Dynamis experience, for example.

'''flags''' Bitmask
{|class="wikitable sortable zebra"
!Value!!Flag
|-
|1||wall handling
|-
|-
|16||delivery inner
|-
|-
|32||inscribable
|-
|-
|64||no auction
|-
|-
|128||scroll
|-
|-
|256||unknown
|-
|-
|512||can use
|-
|-
|1024||can trade npc
|-
|-
|2048||can equip
|-
|-
|4096||no sale
|-
|-
|8192||no delivery
|-
|-
|16384||ex
|-
|-
|32768||rare
|-
|}

'''aH''' is the auction house category for the item.

'''NoSale''' determines if the item can be sold.

'''BaseSell''' is the value of the item when selling to an NPC, before fame modifier.

==item_armor==

Stores information regarding anything that can be worn; armor, accessory, and weapons, too.

'''itemId''' matches what is found in item_basic.

'''name''' needs to be investigated. Just for readability's sake?

'''level''' is what level the item can be equipped at.

'''jobs''' determines what jobs can equip the item, stored as a bitmask. Simply add the values together to set the jobs. WAR (1) + PLD (64) + DRK (128) = 193

{|class="wikitable sortable zebra"
!Value!!Job
|-
|1||warrior
|-
|-
|2||monk
|-
|-
|4||white mage
|-
|-
|8||black mage
|-
|-
|16||red mage
|-
|-
|32||thief
|-
|-
|64||paladin
|-
|-
|128||dark knight
|-
|-
|256||beastmaster
|-
|-
|512||bard
|-
|-
|1024||ranger
|-
|-
|2048||samurai
|-
|-
|4096||ninja
|-
|-
|8192||dragoon
|-
|-
|16384||summoner
|-
|-
|32768||blue mage
|-
|-
|65536||corsair
|-
|-
|131072||puppetmaster
|-
|-
|262144||dancer
|-
|-
|524288||scholar
|-
|-
|1048576||geomancer
|-
|-
|2097152||rune fencer
|-
|}

'''MId''' determines the appearance for the item. Also see [[How_to_Add_an_Item]].

'''shieldSize''' is only used by shields, and determines how much damage they block, and how much damage they'll deal with Shield Bash.

'''scriptType''' needs to be investigated.

'''slot''' determines which slot(s) the item can be worn in, in a bitmask. main hand (1) + off hand (2) = 3.

{|class="wikitable sortable zebra"
!Value!!Valid Slot
|-
|1||main
|-
|-
|2||sub
|-
|-
|4||range
|-
|-
|8||ammo
|-
|-
|16||head
|-
|-
|32||body
|-
|-
|64||hands
|-
|-
|128||legs
|-
|-
|256||feet
|-
|-
|512||neck
|-
|-
|1024||waist
|-
|-
|2048||ear1
|-
|-
|4096||ear2
|-
|-
|8192||ring1
|-
|-
|16384||ring2
|-
|-
|32768||back
|-
|}

'''rslot''' determines which single slot cannot be used while the item is equipped. For example, Vermillion Cloak would reserve the head slot, since head equipment cannot be used with it. This is '''not''' a bitmask, and only one value can be specified.
{|class="wikitable sortable zebra"
!Value!!Reserved Slot
|-
|1||main
|-
|-
|2||range
|-
|-
|3||ammo
|-
|-
|4||head
|-
|-
|5||body
|-
|-
|6||hands
|-
|-
|7||legs
|-
|-
|8||feet
|-
|-
|9||neck
|-
|-
|10||waist
|-
|-
|11||ear1
|-
|-
|12||ear2
|-
|-
|13||ring1
|-
|-
|14||ring2
|-
|-
|15||back
|-
|-
|16||"SLOT_LINK" Linkshell?
|-
|}

==item_weapon==

Stores common information for all weapons.

'''itemId''' links the table to item_basic and item_armor, and should match those tables.

'''name''' is for readability's sake and the name of any script associated with the weapon.

'''skill''' determines which weapon proficiency should be used with the weapon. Note the distinction for guns and marksmanship
{|class="wikitable sortable zebra"
!Value!!Weapon Type
|-
|1||Hand-to-hand
|-
|-
|2||Dagger
|-
|-
|3||Sword
|-
|-
|4||Greatsword
|-
|-
|5||Axe
|-
|-
|6||Great Axe
|-
|-
|7||Scythe
|-
|-
|8||Polearm
|-
|-
|9||Katana
|-
|-
|10||Great Katana
|-
|-
|11||Club
|-
|-
|12||Staff
|-
|-
|25||Archery
|-
|-
|26||Marksmanship
|-
|-
|27||Throwing
|-
|}
'''subskill''' determines exclusivity between marksmanship-type weapons.
{|class="wikitable sortable zebra"
!Value!!Marksmanship Subskill
|-
|0||bolt
|-
|-
|1||gun
|-
|-
|2||cannon
|-
|}

'''dmgType''' determines the type of damage dealt by the weapon. Note that only Hand-to-hand damage will use both hands for jobs such as Monk as of r3200.
{|class="wikitable sortable zebra"
!Value!!Damage Type
|-
|0||Damage type "none"
|-
|-
|1||Piercing
|-
|-
|2||Slashing
|-
|-
|3||Blunt
|-
|-
|4||Hand-to-hand
|-
|-
|5||Crossbow
|-
|-
|6||Gun
|-
|}
'''hit''' is only used for multihit weapons such as Joyeuse or Kraken Club, and represents the maximum number of hits per round.

'''delay''' determines the delay of the weapon. Ranged Weapons and Ammunition always have -240 their displayed delay. For example, Expunger (Delay 360) is stored as 120 delay in the database.

'''dmg''' is the DMG stat for the equipment. Hand-to-hand weapons are always stored with their DMG stat +3. For example, Lizard Cesti has 5 instead of 2.

'''unlock_index''' refers to the id of the weapon in item_weapon_unlocked.

==item_mods==

Stores uncommon information, from Defense to "Enhances Dual Wield Effect."

item_mods is an unindexed table. As such, always keep in mind that it's possible to have duplicate values, which darkstar will cheerfully use without questioning them.

'''itemId''' links the table back to the item via item_basic, and should always match.

'''modId''' is what is being modified. A list of these values can be found in /scripts/globals/status.lua (listed in hexadecimal,) or in /src/map/modifier.h (listed in hexadecimal.) Remember to convert them to decimal for use in this table.

'''value''' is how much of the modifier to grant, and can be positive or negative. It's best to research any modifier you're unsure of, as some are stored and applied in unexpected ways, such as Magic Damage Taken being stored as amount/256, while Physical Damage Taken is stored as amount%.

==item_furniture==

Stores information regarding moghouse furniture.

'''itemId''' links back to item_basic, and should always match.

'''name''' may just be for readability's sake, and is the long name for the item.

'''storage''' is how much storage to grant for each item placed. The core will cap the total at 80.

'''moghancement''' needs to be researched.

'''element''' is the elemental alignment of the furniture.

'''aura''' needs to be researched (strength of effect?)

==item_usable==

Stores information regarding items that can be used. An item cannot be used unless it is in this table.

'''itemid''' links this table back to item_basic, and should match.

'''subid''' seems to primarily be used with spell scrolls, and probably just stores the spellid to be unlocked.

'''name''' may just be for readability's sake.

'''validTargets''' is a bitmask storing what the item can be used on. Being a bitmask, the values should be added for each valid target type. Self (1) + party (2) = 3.
{|class="wikitable sortable zebra"
!Value!!Valid target
|-
|1||Self
|-
|-
|2||Player in user's party
|-
|-
|4||Enemy
|-
|-
|8||Player in user's alliance
|-
|-
|16||Players outside of user's party/alliance
|-
|-
|32||Dead players
|-
|-
|64||NPCs
|-
|}

'''activation''' needs to be researched

'''animation''' determines which animation should be used with the item.

'''animation time''' needs to be researched, but probably determines how long the player can't move for the item usage to succeed.

'''maxCharges''' is the maximum number of usages.

'''useDelay''' is likely how long the item must be equipped before it can be used.

'''reuseDelay''' is likely how long must pass between item uses.

'''aoe''' is a simple binary on whether the item is AoE or not (0 = false, 1 = true.)

==item_latents==

Stores information regarding latent effects on items.

'''itemId''' links back to item_basic, and should always match.

'''modId''' is the number that represents the stat boost when active

'''value''' is the value to add to the stat when active

'''latentId''' is the ID of the latent effect conditions (see src/latent_effect.h)

'''latentParam''' is an additional parameter depending on the latentId (see src/latent_effect.h)

==item_weapon_unlocked==

Stores information related to weaponskill broken weapons.

'''Id''' the ID of the weapon. This only corresponds with a BLOB in the chars table ('''unlocked weapons''') and the entries in the char_weapon_skill_points table.

'''itemId''' is the matching itemId of the weapon from item_basic.

'''name''' is the same name used in item_basic, only useful for reading what the weapon is (and the filename of the script if it has a script)

'''skill''' is the combat skill associated with the weapon (battleentity.h). Note that guns and cannons are different from crossbows.

'''dmgType''' is the type of damage the weapon inflicts (piercing, blunt, handtohand, slashing).

'''hit''' is the number of hits of the weapon.

'''point''' is the amount of weaponskill points needed to "break" the weapon and unlock its associated latent effects.

==item_puppet==

The itemId, name, slot, and "element" of each automaton piece. As PUP isn't in use, this table may change substantially in the future.

Items

2013-04-04T22:09:30Z

Deviltti: /* item_weapon */

==item_basic==

Stores basic item information that is common to all items. For an item to exist, it must have an entry in this table.

'''item_id''' should match what is found in POLUtils or on ffxiah.com

'''name''' is the long name of an item, such as flask_of_echo_drops. If you're scripting a file, this is the file name you should use.

'''sortname''' is the shortened name, such as echo_drops.

'''stackSize''' determines if an item should stack, and how many should stack. The client acts a bit odd if you stack items that aren't supposed to be stacked, but generally will let you stack things like Frozen Giant Skulls if you want to improve the Dynamis experience, for example.

'''flags''' Bitmask
{|class="wikitable sortable zebra"
!Value!!Flag
|-
|1||wall handling
|-
|-
|16||delivery inner
|-
|-
|32||inscribable
|-
|-
|64||no auction
|-
|-
|128||scroll
|-
|-
|256||unknown
|-
|-
|512||can use
|-
|-
|1024||can trade npc
|-
|-
|2048||can equip
|-
|-
|4096||no sale
|-
|-
|8192||no delivery
|-
|-
|16384||ex
|-
|-
|32768||rare
|-
|}

'''aH''' is the auction house category for the item.

'''NoSale''' determines if the item can be sold.

'''BaseSell''' is the value of the item when selling to an NPC, before fame modifier.

==item_armor==

Stores information regarding anything that can be worn; armor, accessory, and weapons, too.

'''itemId''' matches what is found in item_basic.

'''name''' needs to be investigated. Just for readability's sake?

'''level''' is what level the item can be equipped at.

'''jobs''' determines what jobs can equip the item, stored as a bitmask. Simply add the values together to set the jobs. WAR (1) + PLD (64) + DRK (128) = 193

{|class="wikitable sortable zebra"
!Value!!Job
|-
|1||warrior
|-
|-
|2||monk
|-
|-
|4||white mage
|-
|-
|8||black mage
|-
|-
|16||red mage
|-
|-
|32||thief
|-
|-
|64||paladin
|-
|-
|128||dark knight
|-
|-
|256||beastmaster
|-
|-
|512||bard
|-
|-
|1024||ranger
|-
|-
|2048||samurai
|-
|-
|4096||ninja
|-
|-
|8192||dragoon
|-
|-
|16384||summoner
|-
|-
|32768||blue mage
|-
|-
|65536||corsair
|-
|-
|131072||puppetmaster
|-
|-
|262144||dancer
|-
|-
|524288||scholar
|-
|-
|1048576||geomancer
|-
|-
|2097152||rune fencer
|-
|}

'''MId''' determines the appearance for the item. Also see [[How_to_Add_an_Item]].

'''shieldSize''' is only used by shields, and determines how much damage they block, and how much damage they'll deal with Shield Bash.

'''scriptType''' needs to be investigated.

'''slot''' determines which slot(s) the item can be worn in, in a bitmask. main hand (1) + off hand (2) = 3.

{|class="wikitable sortable zebra"
!Value!!Valid Slot
|-
|1||main
|-
|-
|2||sub
|-
|-
|4||range
|-
|-
|8||ammo
|-
|-
|16||head
|-
|-
|32||body
|-
|-
|64||hands
|-
|-
|128||legs
|-
|-
|256||feet
|-
|-
|512||neck
|-
|-
|1024||waist
|-
|-
|2048||ear1
|-
|-
|4096||ear2
|-
|-
|8192||ring1
|-
|-
|16384||ring2
|-
|-
|32768||back
|-
|}

'''rslot''' determines which single slot cannot be used while the item is equipped. For example, Vermillion Cloak would reserve the head slot, since head equipment cannot be used with it. This is '''not''' a bitmask, and only one value can be specified.
{|class="wikitable sortable zebra"
!Value!!Reserved Slot
|-
|1||main
|-
|-
|2||range
|-
|-
|3||ammo
|-
|-
|4||head
|-
|-
|5||body
|-
|-
|6||hands
|-
|-
|7||legs
|-
|-
|8||feet
|-
|-
|9||neck
|-
|-
|10||waist
|-
|-
|11||ear1
|-
|-
|12||ear2
|-
|-
|13||ring1
|-
|-
|14||ring2
|-
|-
|15||back
|-
|-
|16||"SLOT_LINK" Linkshell?
|-
|}

==item_weapon==

Stores common information for all weapons.

'''itemId''' links the table to item_basic and item_armor, and should match those tables.

'''name''' is for readability's sake and the name of any script associated with the weapon.

'''skill''' determines which weapon proficiency should be used with the weapon. Note the distinction for guns and marksmanship
{|class="wikitable sortable zebra"
!Value!!Weapon Type
|-
|1||Hand-to-hand
|-
|-
|2||Dagger
|-
|-
|3||Sword
|-
|-
|4||Greatsword
|-
|-
|5||Axe
|-
|-
|6||Great Axe
|-
|-
|7||Scythe
|-
|-
|8||Polearm
|-
|-
|9||Katana
|-
|-
|10||Great Katana
|-
|-
|11||Club
|-
|-
|12||Staff
|-
|-
|25||Archery
|-
|-
|26||Marksmanship
|-
|-
|27||Throwing
|-
|}

'''dmgType''' determines the type of damage dealt by the weapon. Note that only Hand-to-hand damage will use both hands for jobs such as Monk as of r3200.
{|class="wikitable sortable zebra"
!Value!!Damage Type
|-
|0||Damage type "none"
|-
|-
|1||Piercing
|-
|-
|2||Slashing
|-
|-
|3||Blunt
|-
|-
|4||Hand-to-hand
|-
|-
|5||Crossbow
|-
|-
|6||Gun
|-
|}
'''hit''' is only used for multihit weapons such as Joyeuse or Kraken Club, and represents the maximum number of hits per round.

'''delay''' determines the delay of the weapon. Ranged Weapons and Ammunition always have -240 their displayed delay. For example, Expunger (Delay 360) is stored as 120 delay in the database.

'''dmg''' is the DMG stat for the equipment. Hand-to-hand weapons are always stored with their DMG stat +3. For example, Lizard Cesti has 5 instead of 2.

'''unlock_index''' refers to the id of the weapon in item_weapon_unlocked.

==item_mods==

Stores uncommon information, from Defense to "Enhances Dual Wield Effect."

item_mods is an unindexed table. As such, always keep in mind that it's possible to have duplicate values, which darkstar will cheerfully use without questioning them.

'''itemId''' links the table back to the item via item_basic, and should always match.

'''modId''' is what is being modified. A list of these values can be found in /scripts/globals/status.lua (listed in hexadecimal,) or in /src/map/modifier.h (listed in hexadecimal.) Remember to convert them to decimal for use in this table.

'''value''' is how much of the modifier to grant, and can be positive or negative. It's best to research any modifier you're unsure of, as some are stored and applied in unexpected ways, such as Magic Damage Taken being stored as amount/256, while Physical Damage Taken is stored as amount%.

==item_furniture==

Stores information regarding moghouse furniture.

'''itemId''' links back to item_basic, and should always match.

'''name''' may just be for readability's sake, and is the long name for the item.

'''storage''' is how much storage to grant for each item placed. The core will cap the total at 80.

'''moghancement''' needs to be researched.

'''element''' is the elemental alignment of the furniture.

'''aura''' needs to be researched (strength of effect?)

==item_usable==

Stores information regarding items that can be used. An item cannot be used unless it is in this table.

'''itemid''' links this table back to item_basic, and should match.

'''subid''' seems to primarily be used with spell scrolls, and probably just stores the spellid to be unlocked.

'''name''' may just be for readability's sake.

'''validTargets''' is a bitmask storing what the item can be used on. Being a bitmask, the values should be added for each valid target type. Self (1) + party (2) = 3.
{|class="wikitable sortable zebra"
!Value!!Valid target
|-
|1||Self
|-
|-
|2||Player in user's party
|-
|-
|4||Enemy
|-
|-
|8||Player in user's alliance
|-
|-
|16||Players outside of user's party/alliance
|-
|-
|32||Dead players
|-
|-
|64||NPCs
|-
|}

'''activation''' needs to be researched

'''animation''' determines which animation should be used with the item.

'''animation time''' needs to be researched, but probably determines how long the player can't move for the item usage to succeed.

'''maxCharges''' is the maximum number of usages.

'''useDelay''' is likely how long the item must be equipped before it can be used.

'''reuseDelay''' is likely how long must pass between item uses.

'''aoe''' is a simple binary on whether the item is AoE or not (0 = false, 1 = true.)

==item_latents==

Stores information regarding latent effects on items.

'''itemId''' links back to item_basic, and should always match.

'''modId''' is the number that represents the stat boost when active

'''value''' is the value to add to the stat when active

'''latentId''' is the ID of the latent effect conditions (see src/latent_effect.h)

'''latentParam''' is an additional parameter depending on the latentId (see src/latent_effect.h)

==item_weapon_unlocked==

Stores information related to weaponskill broken weapons.

'''Id''' the ID of the weapon. This only corresponds with a BLOB in the chars table ('''unlocked weapons''') and the entries in the char_weapon_skill_points table.

'''itemId''' is the matching itemId of the weapon from item_basic.

'''name''' is the same name used in item_basic, only useful for reading what the weapon is (and the filename of the script if it has a script)

'''skill''' is the combat skill associated with the weapon (battleentity.h). Note that guns and cannons are different from crossbows.

'''dmgType''' is the type of damage the weapon inflicts (piercing, blunt, handtohand, slashing).

'''hit''' is the number of hits of the weapon.

'''point''' is the amount of weaponskill points needed to "break" the weapon and unlock its associated latent effects.

==item_puppet==

The itemId, name, slot, and "element" of each automaton piece. As PUP isn't in use, this table may change substantially in the future.

Items

2013-04-04T22:02:06Z

Deviltti:

==item_basic==

Stores basic item information that is common to all items. For an item to exist, it must have an entry in this table.

'''item_id''' should match what is found in POLUtils or on ffxiah.com

'''name''' is the long name of an item, such as flask_of_echo_drops. If you're scripting a file, this is the file name you should use.

'''sortname''' is the shortened name, such as echo_drops.

'''stackSize''' determines if an item should stack, and how many should stack. The client acts a bit odd if you stack items that aren't supposed to be stacked, but generally will let you stack things like Frozen Giant Skulls if you want to improve the Dynamis experience, for example.

'''flags''' Bitmask
{|class="wikitable sortable zebra"
!Value!!Flag
|-
|1||wall handling
|-
|-
|16||delivery inner
|-
|-
|32||inscribable
|-
|-
|64||no auction
|-
|-
|128||scroll
|-
|-
|256||unknown
|-
|-
|512||can use
|-
|-
|1024||can trade npc
|-
|-
|2048||can equip
|-
|-
|4096||no sale
|-
|-
|8192||no delivery
|-
|-
|16384||ex
|-
|-
|32768||rare
|-
|}

'''aH''' is the auction house category for the item.

'''NoSale''' determines if the item can be sold.

'''BaseSell''' is the value of the item when selling to an NPC, before fame modifier.

==item_armor==

Stores information regarding anything that can be worn; armor, accessory, and weapons, too.

'''itemId''' matches what is found in item_basic.

'''name''' needs to be investigated. Just for readability's sake?

'''level''' is what level the item can be equipped at.

'''jobs''' determines what jobs can equip the item, stored as a bitmask. Simply add the values together to set the jobs. WAR (1) + PLD (64) + DRK (128) = 193

{|class="wikitable sortable zebra"
!Value!!Job
|-
|1||warrior
|-
|-
|2||monk
|-
|-
|4||white mage
|-
|-
|8||black mage
|-
|-
|16||red mage
|-
|-
|32||thief
|-
|-
|64||paladin
|-
|-
|128||dark knight
|-
|-
|256||beastmaster
|-
|-
|512||bard
|-
|-
|1024||ranger
|-
|-
|2048||samurai
|-
|-
|4096||ninja
|-
|-
|8192||dragoon
|-
|-
|16384||summoner
|-
|-
|32768||blue mage
|-
|-
|65536||corsair
|-
|-
|131072||puppetmaster
|-
|-
|262144||dancer
|-
|-
|524288||scholar
|-
|-
|1048576||geomancer
|-
|-
|2097152||rune fencer
|-
|}

'''MId''' determines the appearance for the item. Also see [[How_to_Add_an_Item]].

'''shieldSize''' is only used by shields, and determines how much damage they block, and how much damage they'll deal with Shield Bash.

'''scriptType''' needs to be investigated.

'''slot''' determines which slot(s) the item can be worn in, in a bitmask. main hand (1) + off hand (2) = 3.

{|class="wikitable sortable zebra"
!Value!!Valid Slot
|-
|1||main
|-
|-
|2||sub
|-
|-
|4||range
|-
|-
|8||ammo
|-
|-
|16||head
|-
|-
|32||body
|-
|-
|64||hands
|-
|-
|128||legs
|-
|-
|256||feet
|-
|-
|512||neck
|-
|-
|1024||waist
|-
|-
|2048||ear1
|-
|-
|4096||ear2
|-
|-
|8192||ring1
|-
|-
|16384||ring2
|-
|-
|32768||back
|-
|}

'''rslot''' determines which single slot cannot be used while the item is equipped. For example, Vermillion Cloak would reserve the head slot, since head equipment cannot be used with it. This is '''not''' a bitmask, and only one value can be specified.
{|class="wikitable sortable zebra"
!Value!!Reserved Slot
|-
|1||main
|-
|-
|2||range
|-
|-
|3||ammo
|-
|-
|4||head
|-
|-
|5||body
|-
|-
|6||hands
|-
|-
|7||legs
|-
|-
|8||feet
|-
|-
|9||neck
|-
|-
|10||waist
|-
|-
|11||ear1
|-
|-
|12||ear2
|-
|-
|13||ring1
|-
|-
|14||ring2
|-
|-
|15||back
|-
|-
|16||"SLOT_LINK" Linkshell?
|-
|}

==item_weapon==

Stores common information for all weapons.

'''itemId''' links the table to item_basic and item_armor, and should match those tables.

'''name''' is for readability's sake and the name of any script associated with the weapon.

'''skill''' determines which weapon proficiency should be used with the weapon. Note the distinction for guns and marksmanship
{|class="wikitable sortable zebra"
!Value!!Weapon Type
|-
|1||Hand-to-hand
|-
|-
|2||Dagger
|-
|-
|3||Sword
|-
|-
|4||Greatsword
|-
|-
|5||Axe
|-
|-
|6||Great Axe
|-
|-
|7||Scythe
|-
|-
|8||Polearm
|-
|-
|9||Katana
|-
|-
|10||Great Katana
|-
|-
|11||Club
|-
|-
|12||Staff
|-
|-
|24||Gun
|-
|-
|25||Archery
|-
|-
|26||Marksmanship
|-
|-
|27||Throwing
|-
|}

'''dmgType''' determines the type of damage dealt by the weapon. Note that only Hand-to-hand damage will use both hands for jobs such as Monk as of r3200.
{|class="wikitable sortable zebra"
!Value!!Damage Type
|-
|0||Damage type "none"
|-
|-
|1||Piercing
|-
|-
|2||Slashing
|-
|-
|3||Blunt
|-
|-
|4||Hand-to-hand
|-
|-
|5||Crossbow
|-
|-
|6||Gun
|-
|}
'''hit''' is only used for multihit weapons such as Joyeuse or Kraken Club, and represents the maximum number of hits per round.

'''delay''' determines the delay of the weapon. Ranged Weapons and Ammunition always have -240 their displayed delay. For example, Expunger (Delay 360) is stored as 120 delay in the database.

'''dmg''' is the DMG stat for the equipment. Hand-to-hand weapons are always stored with their DMG stat +3. For example, Lizard Cesti has 5 instead of 2.

'''unlock_index''' refers to the id of the weapon in item_weapon_unlocked.

==item_mods==

Stores uncommon information, from Defense to "Enhances Dual Wield Effect."

item_mods is an unindexed table. As such, always keep in mind that it's possible to have duplicate values, which darkstar will cheerfully use without questioning them.

'''itemId''' links the table back to the item via item_basic, and should always match.

'''modId''' is what is being modified. A list of these values can be found in /scripts/globals/status.lua (listed in hexadecimal,) or in /src/map/modifier.h (listed in hexadecimal.) Remember to convert them to decimal for use in this table.

'''value''' is how much of the modifier to grant, and can be positive or negative. It's best to research any modifier you're unsure of, as some are stored and applied in unexpected ways, such as Magic Damage Taken being stored as amount/256, while Physical Damage Taken is stored as amount%.

==item_furniture==

Stores information regarding moghouse furniture.

'''itemId''' links back to item_basic, and should always match.

'''name''' may just be for readability's sake, and is the long name for the item.

'''storage''' is how much storage to grant for each item placed. The core will cap the total at 80.

'''moghancement''' needs to be researched.

'''element''' is the elemental alignment of the furniture.

'''aura''' needs to be researched (strength of effect?)

==item_usable==

Stores information regarding items that can be used. An item cannot be used unless it is in this table.

'''itemid''' links this table back to item_basic, and should match.

'''subid''' seems to primarily be used with spell scrolls, and probably just stores the spellid to be unlocked.

'''name''' may just be for readability's sake.

'''validTargets''' is a bitmask storing what the item can be used on. Being a bitmask, the values should be added for each valid target type. Self (1) + party (2) = 3.
{|class="wikitable sortable zebra"
!Value!!Valid target
|-
|1||Self
|-
|-
|2||Player in user's party
|-
|-
|4||Enemy
|-
|-
|8||Player in user's alliance
|-
|-
|16||Players outside of user's party/alliance
|-
|-
|32||Dead players
|-
|-
|64||NPCs
|-
|}

'''activation''' needs to be researched

'''animation''' determines which animation should be used with the item.

'''animation time''' needs to be researched, but probably determines how long the player can't move for the item usage to succeed.

'''maxCharges''' is the maximum number of usages.

'''useDelay''' is likely how long the item must be equipped before it can be used.

'''reuseDelay''' is likely how long must pass between item uses.

'''aoe''' is a simple binary on whether the item is AoE or not (0 = false, 1 = true.)

==item_latents==

Stores information regarding latent effects on items.

'''itemId''' links back to item_basic, and should always match.

'''modId''' is the number that represents the stat boost when active

'''value''' is the value to add to the stat when active

'''latentId''' is the ID of the latent effect conditions (see src/latent_effect.h)

'''latentParam''' is an additional parameter depending on the latentId (see src/latent_effect.h)

==item_weapon_unlocked==

Stores information related to weaponskill broken weapons.

'''Id''' the ID of the weapon. This only corresponds with a BLOB in the chars table ('''unlocked weapons''') and the entries in the char_weapon_skill_points table.

'''itemId''' is the matching itemId of the weapon from item_basic.

'''name''' is the same name used in item_basic, only useful for reading what the weapon is (and the filename of the script if it has a script)

'''skill''' is the combat skill associated with the weapon (battleentity.h). Note that guns and cannons are different from crossbows.

'''dmgType''' is the type of damage the weapon inflicts (piercing, blunt, handtohand, slashing).

'''hit''' is the number of hits of the weapon.

'''point''' is the amount of weaponskill points needed to "break" the weapon and unlock its associated latent effects.

==item_puppet==

The itemId, name, slot, and "element" of each automaton piece. As PUP isn't in use, this table may change substantially in the future.

Items

2013-04-04T21:56:40Z

Deviltti:

==item_basic==

Stores basic item information that is common to all items. For an item to exist, it must have an entry in this table.

'''item_id''' should match what is found in POLUtils or on ffxiah.com

'''name''' is the long name of an item, such as flask_of_echo_drops. If you're scripting a file, this is the file name you should use.

'''sortname''' is the shortened name, such as echo_drops.

'''stackSize''' determines if an item should stack, and how many should stack. The client acts a bit odd if you stack items that aren't supposed to be stacked, but generally will let you stack things like Frozen Giant Skulls if you want to improve the Dynamis experience, for example.

'''flags''' Bitmask
{|class="wikitable sortable zebra"
!Value!!Flag
|-
|1||wall handling
|-
|-
|16||delivery inner
|-
|-
|32||inscribable
|-
|-
|64||no auction
|-
|-
|128||scroll
|-
|-
|256||unknown
|-
|-
|512||can use
|-
|-
|1024||can trade npc
|-
|-
|2048||can equip
|-
|-
|4096||no sale
|-
|-
|8192||no delivery
|-
|-
|16384||ex
|-
|-
|32768||rare
|-
|}

'''aH''' is the auction house category for the item.

'''NoSale''' determines if the item can be sold.

'''BaseSell''' is the value of the item when selling to an NPC, before fame modifier.

==item_armor==

Stores information regarding anything that can be worn; armor, accessory, and weapons, too.

'''itemId''' matches what is found in item_basic.

'''name''' needs to be investigated. Just for readability's sake?

'''level''' is what level the item can be equipped at.

'''jobs''' determines what jobs can equip the item, stored as a bitmask. Simply add the values together to set the jobs. WAR (1) + PLD (64) + DRK (128) = 193

{|class="wikitable sortable zebra"
!Value!!Job
|-
|1||warrior
|-
|-
|2||monk
|-
|-
|4||white mage
|-
|-
|8||black mage
|-
|-
|16||red mage
|-
|-
|32||thief
|-
|-
|64||paladin
|-
|-
|128||dark knight
|-
|-
|256||beastmaster
|-
|-
|512||bard
|-
|-
|1024||ranger
|-
|-
|2048||samurai
|-
|-
|4096||ninja
|-
|-
|8192||dragoon
|-
|-
|16384||summoner
|-
|-
|32768||blue mage
|-
|-
|65536||corsair
|-
|-
|131072||puppetmaster
|-
|-
|262144||dancer
|-
|-
|524288||scholar
|-
|-
|1048576||geomancer
|-
|-
|2097152||rune fencer
|-
|}

'''MId''' determines the appearance for the item. Also see [[How_to_Add_an_Item]].

'''shieldSize''' is only used by shields, and determines how much damage they block, and how much damage they'll deal with Shield Bash.

'''scriptType''' needs to be investigated.

'''slot''' determines which slot(s) the item can be worn in, in a bitmask. main hand (1) + off hand (2) = 3.

{|class="wikitable sortable zebra"
!Value!!Valid Slot
|-
|1||main hand
|-
|-
|2||offhand
|-
|-
|4||ranged
|-
|-
|8||ammo
|-
|-
|16||head
|-
|-
|32||body
|-
|-
|64||hands
|-
|-
|128||legs
|-
|-
|256||feet
|-
|-
|512||neck
|-
|-
|1024||belt
|-
|-
|2048||l earring
|-
|-
|4096||r earring
|-
|-
|8192||l ring
|-
|-
|16384||r ring
|-
|-
|32768||cape
|-
|}

'''rslot''' determines which single slot cannot be used while the item is equipped. For example, Vermillion Cloak would reserve the head slot, since head equipment cannot be used with it. This is '''not''' a bitmask, and only one value can be specified.
{|class="wikitable sortable zebra"
!Value!!Reserved Slot
|-
|1||offhand
|-
|-
|2||ranged
|-
|-
|3||ammo
|-
|-
|4||head
|-
|-
|5||body
|-
|-
|6||hands
|-
|-
|7||legs
|-
|-
|8||feet
|-
|-
|9||neck
|-
|-
|10||belt
|-
|-
|11||l earring
|-
|-
|12||r earring
|-
|-
|13||l ring
|-
|-
|14||r ring
|-
|-
|15||cape
|-
|-
|16||"SLOT_LINK" Linkshell?
|-
|}

==item_weapon==

Stores common information for all weapons.

'''itemId''' links the table to item_basic and item_armor, and should match those tables.

'''name''' is for readability's sake and the name of any script associated with the weapon.

'''skill''' determines which weapon proficiency should be used with the weapon. Note the distinction for guns and marksmanship
{|class="wikitable sortable zebra"
!Value!!Weapon Type
|-
|1||Hand-to-hand
|-
|-
|2||Dagger
|-
|-
|3||Sword
|-
|-
|4||Greatsword
|-
|-
|5||Axe
|-
|-
|6||Great Axe
|-
|-
|7||Scythe
|-
|-
|8||Polearm
|-
|-
|9||Katana
|-
|-
|10||Great Katana
|-
|-
|11||Club
|-
|-
|12||Staff
|-
|-
|24||Gun
|-
|-
|25||Archery
|-
|-
|26||Marksmanship
|-
|-
|27||Throwing
|-
|}

'''dmgType''' determines the type of damage dealt by the weapon. Note that only Hand-to-hand damage will use both hands for jobs such as Monk as of r3200.
{|class="wikitable sortable zebra"
!Value!!Damage Type
|-
|0||Damage type "none"
|-
|-
|1||Piercing
|-
|-
|2||Slashing
|-
|-
|3||Blunt
|-
|-
|4||Hand-to-hand
|-
|-
|5||Crossbow
|-
|-
|6||Gun
|-
|}
'''hit''' is only used for multihit weapons such as Joyeuse or Kraken Club, and represents the maximum number of hits per round.

'''delay''' determines the delay of the weapon. Ranged Weapons and Ammunition always have -240 their displayed delay. For example, Expunger (Delay 360) is stored as 120 delay in the database.

'''dmg''' is the DMG stat for the equipment. Hand-to-hand weapons are always stored with their DMG stat +3. For example, Lizard Cesti has 5 instead of 2.

'''unlock_index''' refers to the id of the weapon in item_weapon_unlocked.

==item_mods==

Stores uncommon information, from Defense to "Enhances Dual Wield Effect."

item_mods is an unindexed table. As such, always keep in mind that it's possible to have duplicate values, which darkstar will cheerfully use without questioning them.

'''itemId''' links the table back to the item via item_basic, and should always match.

'''modId''' is what is being modified. A list of these values can be found in /scripts/globals/status.lua (listed in hexadecimal,) or in /src/map/modifier.h (listed in hexadecimal.) Remember to convert them to decimal for use in this table.

'''value''' is how much of the modifier to grant, and can be positive or negative. It's best to research any modifier you're unsure of, as some are stored and applied in unexpected ways, such as Magic Damage Taken being stored as amount/256, while Physical Damage Taken is stored as amount%.

==item_furniture==

Stores information regarding moghouse furniture.

'''itemId''' links back to item_basic, and should always match.

'''name''' may just be for readability's sake, and is the long name for the item.

'''storage''' is how much storage to grant for each item placed. The core will cap the total at 80.

'''moghancement''' needs to be researched.

'''element''' is the elemental alignment of the furniture.

'''aura''' needs to be researched (strength of effect?)

==item_usable==

Stores information regarding items that can be used. An item cannot be used unless it is in this table.

'''itemid''' links this table back to item_basic, and should match.

'''subid''' seems to primarily be used with spell scrolls, and probably just stores the spellid to be unlocked.

'''name''' may just be for readability's sake.

'''validTargets''' is a bitmask storing what the item can be used on. Being a bitmask, the values should be added for each valid target type. Self (1) + party (2) = 3.
{|class="wikitable sortable zebra"
!Value!!Valid target
|-
|1||Self
|-
|-
|2||Player in user's party
|-
|-
|4||Enemy
|-
|-
|8||Player in user's alliance
|-
|-
|16||Players outside of user's party/alliance
|-
|-
|32||Dead players
|-
|-
|64||NPCs
|-
|}

'''activation''' needs to be researched

'''animation''' determines which animation should be used with the item.

'''animation time''' needs to be researched, but probably determines how long the player can't move for the item usage to succeed.

'''maxCharges''' is the maximum number of usages.

'''useDelay''' is likely how long the item must be equipped before it can be used.

'''reuseDelay''' is likely how long must pass between item uses.

'''aoe''' is a simple binary on whether the item is AoE or not (0 = false, 1 = true.)

==item_latents==

Stores information regarding latent effects on items.

'''itemId''' links back to item_basic, and should always match.

'''modId''' is the number that represents the stat boost when active

'''value''' is the value to add to the stat when active

'''latentId''' is the ID of the latent effect conditions (see src/latent_effect.h)

'''latentParam''' is an additional parameter depending on the latentId (see src/latent_effect.h)

==item_weapon_unlocked==

Stores information related to weaponskill broken weapons.

'''Id''' the ID of the weapon. This only corresponds with a BLOB in the chars table ('''unlocked weapons''') and the entries in the char_weapon_skill_points table.

'''itemId''' is the matching itemId of the weapon from item_basic.

'''name''' is the same name used in item_basic, only useful for reading what the weapon is (and the filename of the script if it has a script)

'''skill''' is the combat skill associated with the weapon (battleentity.h). Note that guns and cannons are different from crossbows.

'''dmgType''' is the type of damage the weapon inflicts (piercing, blunt, handtohand, slashing).

'''hit''' is the number of hits of the weapon.

'''point''' is the amount of weaponskill points needed to "break" the weapon and unlock its associated latent effects.

==item_puppet==

The itemId, name, slot, and "element" of each automaton piece. As PUP isn't in use, this table may change substantially in the future.

Items

2013-04-04T21:55:46Z

Deviltti:

==item_basic==

Stores basic item information that is common to all items. For an item to exist, it must have an entry in this table.

'''item_id''' should match what is found in POLUtils or on ffxiah.com

'''name''' is the long name of an item, such as flask_of_echo_drops. If you're scripting a file, this is the file name you should use.

'''sortname''' is the shortened name, such as echo_drops.

'''stackSize''' determines if an item should stack, and how many should stack. The client acts a bit odd if you stack items that aren't supposed to be stacked, but generally will let you stack things like Frozen Giant Skulls if you want to improve the Dynamis experience, for example.

'''flags''' needs to be investigated. Likely handles rare/ex and other behavior.
{|class="wikitable sortable zebra"
!Value!!Job
|-
|1||wall handling
|-
|-
|16||delivery inner
|-
|-
|32||inscribable
|-
|-
|64||no auction
|-
|-
|128||scroll
|-
|-
|256||unknown
|-
|-
|512||can use
|-
|-
|1024||can trade npc
|-
|-
|2048||can equip
|-
|-
|4096||no sale
|-
|-
|8192||no delivery
|-
|-
|16384||ex
|-
|-
|32768||rare
|-
|}

'''aH''' is the auction house category for the item.

'''NoSale''' determines if the item can be sold.

'''BaseSell''' is the value of the item when selling to an NPC, before fame modifier.

==item_armor==

Stores information regarding anything that can be worn; armor, accessory, and weapons, too.

'''itemId''' matches what is found in item_basic.

'''name''' needs to be investigated. Just for readability's sake?

'''level''' is what level the item can be equipped at.

'''jobs''' determines what jobs can equip the item, stored as a bitmask. Simply add the values together to set the jobs. WAR (1) + PLD (64) + DRK (128) = 193

{|class="wikitable sortable zebra"
!Value!!Job
|-
|1||warrior
|-
|-
|2||monk
|-
|-
|4||white mage
|-
|-
|8||black mage
|-
|-
|16||red mage
|-
|-
|32||thief
|-
|-
|64||paladin
|-
|-
|128||dark knight
|-
|-
|256||beastmaster
|-
|-
|512||bard
|-
|-
|1024||ranger
|-
|-
|2048||samurai
|-
|-
|4096||ninja
|-
|-
|8192||dragoon
|-
|-
|16384||summoner
|-
|-
|32768||blue mage
|-
|-
|65536||corsair
|-
|-
|131072||puppetmaster
|-
|-
|262144||dancer
|-
|-
|524288||scholar
|-
|-
|1048576||geomancer
|-
|-
|2097152||rune fencer
|-
|}

'''MId''' determines the appearance for the item. Also see [[How_to_Add_an_Item]].

'''shieldSize''' is only used by shields, and determines how much damage they block, and how much damage they'll deal with Shield Bash.

'''scriptType''' needs to be investigated.

'''slot''' determines which slot(s) the item can be worn in, in a bitmask. main hand (1) + off hand (2) = 3.

{|class="wikitable sortable zebra"
!Value!!Valid Slot
|-
|1||main hand
|-
|-
|2||offhand
|-
|-
|4||ranged
|-
|-
|8||ammo
|-
|-
|16||head
|-
|-
|32||body
|-
|-
|64||hands
|-
|-
|128||legs
|-
|-
|256||feet
|-
|-
|512||neck
|-
|-
|1024||belt
|-
|-
|2048||l earring
|-
|-
|4096||r earring
|-
|-
|8192||l ring
|-
|-
|16384||r ring
|-
|-
|32768||cape
|-
|}

'''rslot''' determines which single slot cannot be used while the item is equipped. For example, Vermillion Cloak would reserve the head slot, since head equipment cannot be used with it. This is '''not''' a bitmask, and only one value can be specified.
{|class="wikitable sortable zebra"
!Value!!Reserved Slot
|-
|1||offhand
|-
|-
|2||ranged
|-
|-
|3||ammo
|-
|-
|4||head
|-
|-
|5||body
|-
|-
|6||hands
|-
|-
|7||legs
|-
|-
|8||feet
|-
|-
|9||neck
|-
|-
|10||belt
|-
|-
|11||l earring
|-
|-
|12||r earring
|-
|-
|13||l ring
|-
|-
|14||r ring
|-
|-
|15||cape
|-
|-
|16||"SLOT_LINK" Linkshell?
|-
|}

==item_weapon==

Stores common information for all weapons.

'''itemId''' links the table to item_basic and item_armor, and should match those tables.

'''name''' is for readability's sake and the name of any script associated with the weapon.

'''skill''' determines which weapon proficiency should be used with the weapon. Note the distinction for guns and marksmanship
{|class="wikitable sortable zebra"
!Value!!Weapon Type
|-
|1||Hand-to-hand
|-
|-
|2||Dagger
|-
|-
|3||Sword
|-
|-
|4||Greatsword
|-
|-
|5||Axe
|-
|-
|6||Great Axe
|-
|-
|7||Scythe
|-
|-
|8||Polearm
|-
|-
|9||Katana
|-
|-
|10||Great Katana
|-
|-
|11||Club
|-
|-
|12||Staff
|-
|-
|24||Gun
|-
|-
|25||Archery
|-
|-
|26||Marksmanship
|-
|-
|27||Throwing
|-
|}

'''dmgType''' determines the type of damage dealt by the weapon. Note that only Hand-to-hand damage will use both hands for jobs such as Monk as of r3200.
{|class="wikitable sortable zebra"
!Value!!Damage Type
|-
|0||Damage type "none"
|-
|-
|1||Piercing
|-
|-
|2||Slashing
|-
|-
|3||Blunt
|-
|-
|4||Hand-to-hand
|-
|-
|5||Crossbow
|-
|-
|6||Gun
|-
|}
'''hit''' is only used for multihit weapons such as Joyeuse or Kraken Club, and represents the maximum number of hits per round.

'''delay''' determines the delay of the weapon. Ranged Weapons and Ammunition always have -240 their displayed delay. For example, Expunger (Delay 360) is stored as 120 delay in the database.

'''dmg''' is the DMG stat for the equipment. Hand-to-hand weapons are always stored with their DMG stat +3. For example, Lizard Cesti has 5 instead of 2.

'''unlock_index''' refers to the id of the weapon in item_weapon_unlocked.

==item_mods==

Stores uncommon information, from Defense to "Enhances Dual Wield Effect."

item_mods is an unindexed table. As such, always keep in mind that it's possible to have duplicate values, which darkstar will cheerfully use without questioning them.

'''itemId''' links the table back to the item via item_basic, and should always match.

'''modId''' is what is being modified. A list of these values can be found in /scripts/globals/status.lua (listed in hexadecimal,) or in /src/map/modifier.h (listed in hexadecimal.) Remember to convert them to decimal for use in this table.

'''value''' is how much of the modifier to grant, and can be positive or negative. It's best to research any modifier you're unsure of, as some are stored and applied in unexpected ways, such as Magic Damage Taken being stored as amount/256, while Physical Damage Taken is stored as amount%.

==item_furniture==

Stores information regarding moghouse furniture.

'''itemId''' links back to item_basic, and should always match.

'''name''' may just be for readability's sake, and is the long name for the item.

'''storage''' is how much storage to grant for each item placed. The core will cap the total at 80.

'''moghancement''' needs to be researched.

'''element''' is the elemental alignment of the furniture.

'''aura''' needs to be researched (strength of effect?)

==item_usable==

Stores information regarding items that can be used. An item cannot be used unless it is in this table.

'''itemid''' links this table back to item_basic, and should match.

'''subid''' seems to primarily be used with spell scrolls, and probably just stores the spellid to be unlocked.

'''name''' may just be for readability's sake.

'''validTargets''' is a bitmask storing what the item can be used on. Being a bitmask, the values should be added for each valid target type. Self (1) + party (2) = 3.
{|class="wikitable sortable zebra"
!Value!!Valid target
|-
|1||Self
|-
|-
|2||Player in user's party
|-
|-
|4||Enemy
|-
|-
|8||Player in user's alliance
|-
|-
|16||Players outside of user's party/alliance
|-
|-
|32||Dead players
|-
|-
|64||NPCs
|-
|}

'''activation''' needs to be researched

'''animation''' determines which animation should be used with the item.

'''animation time''' needs to be researched, but probably determines how long the player can't move for the item usage to succeed.

'''maxCharges''' is the maximum number of usages.

'''useDelay''' is likely how long the item must be equipped before it can be used.

'''reuseDelay''' is likely how long must pass between item uses.

'''aoe''' is a simple binary on whether the item is AoE or not (0 = false, 1 = true.)

==item_latents==

Stores information regarding latent effects on items.

'''itemId''' links back to item_basic, and should always match.

'''modId''' is the number that represents the stat boost when active

'''value''' is the value to add to the stat when active

'''latentId''' is the ID of the latent effect conditions (see src/latent_effect.h)

'''latentParam''' is an additional parameter depending on the latentId (see src/latent_effect.h)

==item_weapon_unlocked==

Stores information related to weaponskill broken weapons.

'''Id''' the ID of the weapon. This only corresponds with a BLOB in the chars table ('''unlocked weapons''') and the entries in the char_weapon_skill_points table.

'''itemId''' is the matching itemId of the weapon from item_basic.

'''name''' is the same name used in item_basic, only useful for reading what the weapon is (and the filename of the script if it has a script)

'''skill''' is the combat skill associated with the weapon (battleentity.h). Note that guns and cannons are different from crossbows.

'''dmgType''' is the type of damage the weapon inflicts (piercing, blunt, handtohand, slashing).

'''hit''' is the number of hits of the weapon.

'''point''' is the amount of weaponskill points needed to "break" the weapon and unlock its associated latent effects.

==item_puppet==

The itemId, name, slot, and "element" of each automaton piece. As PUP isn't in use, this table may change substantially in the future.

Basic database primer

2013-04-03T02:32:53Z

Deviltti:

This page is meant to sort of explain the ropes of navigating a database, and kind of give a rough primer for SQL novices so that they can learn to crawl, then walk, and then maybe even dance a little. I'm going to assume you're using Navicat, since you're not familiar with a database and that's what Bluekirby0's guides recommend.

==Lesson One: Backups, backups, backups==

First off, a sort of warning with SQL. There's no "undo" function. If you change something, it's changed. If you don't remember what it used to be, there's not really a way to get that back. If you're doing something risky like editing character tables, click on "Tables" in the tree on the left side, and select the accounts and char tables. Right click and select "Dump Tables." This will let you make an SQL file that has a copy of your database, in case you make a mistake. Using this file is similar to updating your database normally, except you'll have to manually drop (delete) the tables before you can put the old data back into them.

Secondly, there's two types of tables: indexed and unindexed. Indexed tables will have one value that must always be unique. In the case of Darkstar, this will be things like itemId, npcid, and mobid. Unindexed tables can have duplicate values, and are also slower to query, although the speed difference may not be noticeable. Some examples of unindexed tables are item_mods, char_titles, and char_vars. These tables have their uses, but generally if you can store data in one or the other, and the data is going to be persistent and frequent like which outpost warps a character has unlocked, you should use indexed tables.

Thirdly, you can save queries. I have a "Customizations" query saved that changes a number of things so that I can quickly rechange any tables that get updated. This way, the inventory clutter in dynamis will go back to stacking, I'll have Sekkanoki at L40, and I can use Judge's Cap and Judge's Belt to do haste tests.

Fourthly, a lot of people forget about triggers.sql. That particular file made some changes to the chars table (among others) so that if a character is deleted, their entries in all the other character related tables are cleared out. Just remember that this can and will happen if you delete anything from chars.

Fifthly, comments. You can use these when necessary to keep track of what something means, or just as little post it notes. A comment has to be prefixed by two dashes, and may need a space before and after the dash, depending on usage. Here's an example of comments in use:

-- Missing mIDs

-- Certain

UPDATE `item_armor` SET mID = '327' WHERE itemId IN (10452,10502,10602,10878,11971); -- Rubeus

-- Confident

UPDATE `item_armor` SET mID = '16' WHERE itemId = 11525; -- Maestria Mask

You can also use comments if you want to temporarily remove a line from usage, but you don't want to delete the line from your query permanently.

==Lesson Two: The SELECT Query==

Next, an introduction to building queries.

The most basic query, and the one you'll use the most, is a SELECT query. A SELECT query fetches data from a data source, and lists it out for you. A good rule of thumb is to use a SELECT query to see what you'll be changing or deleting before you do it. It's also a safe way to introduce yourself to SQL, since nothing is being changed. The syntax is:

SELECT '''columns''' FROM '''data source''' WHERE '''conditions''';

The capitalization isn't necessary for the query to work, but it can make queries easier to read, once you're used to them. The semi-colon at the end is required, however. You can use a grave (above tab and next to the number 1, often called the "tilde key") instead of quotes in some places, and also around table_names. However, you can't always use single quotes and double quotes in those situations.

'''columns''' is a list of the columns you want to see. Alternatively, you can just use an asterisk (*) to view all columns.

'''data source''' is a table, or multiple tables, that you want to get data from.

'''conditions''' are things that help you narrow down your search. There's actually quite a few of these that you can use, which I'll go into.

... WHERE column = "value";

This is the most basic of conditionals. An example would be WHERE itemId = 17440; to bring up the Kraken Club. You could also use WHERE mobname = "Serket"; Note that numbers do not require quotation marks, but words will require either single or double quotes.

... WHERE column LIKE "%value%";

The percentage sign acts as a wild card, so "Kraken_%", "12%", or "%Behemo%" would all be the sort of thing you could use.

... WHERE column IN (value1, value2, value3...);

This lets you specify multiple values that can be matched. For example, WHERE itemId IN (15270, 15543); would return the Walahra Turban and Rajas Ring.

... WHERE column BETWEEN value1 AND value2;

Here you can specify a range of values. WHERE npcid BETWEEN 1000 AND 3000; would return all NPCs with an ID between 1000 and 3000.

You can also do a complex query, such as WHERE mobname LIKE "Goblin_%" AND zoneid = 154; to specify any mobname starting with "Goblin_" in zone 154 (Dragon's Aery.)

So, let's put that all together. Here's a query I used to find armor that was missing the appearance information:

SELECT * FROM item_armor WHERE MId = 0 AND slot NOT IN (1,2,3,4,8,512,1024,6144,24576,32768) ORDER BY level ASC;

The MId is the appearance for a piece of armor. 0 will have no appearance at all. Also notice the "NOT" used to negate the second query. That means to return results that DON'T match what you're specifying. Finally, you haven't seen ORDER BY yet. You can use this to sort your results by a column, either ASCending or DESCending. In this case, I'm sorting by level from 1 to 99.

==Lesson Three: Complex Selects==

Now to introduce you to queries that use multiple tables. You might have wondered why we use itemId in pretty much every table that has items in it. This makes it easy to get matching information from multiple tables. Here's an example I've been using pretty often lately:

SELECT npcid, npc_list.name, zone_settings.name, zone_settings.zoneid, pos_x, pos_y, pos_z, animation, hex(look) FROM npc_list, zone_settings WHERE npc_list.zoneid = zone_settings.zoneid AND npc_list.zoneid = 14;

You'll notice this query is a lot longer than what you've seen so far. This query fetches a few columns from the npc_list table, along with the name of the zone for convenience. That's literally the only reason I included zone_settings, in this case.

The second thing you may have noticed is that I didn't use * this time. npc_list has a lot of columns, and some of them I didn't care about, and * would have brought in all of them, along with all of zone_settings. This also lets me control the order of the columns. As part of this, I used npc_list.name to specify I wanted the name column in the npc_list table, since zone_settings also has a name column.

The third thing you should see is that I used multiple tables after "FROM." That's how the whole thing works, and you can really use as many tables as you can logically connect here.

Speaking of logically connected, the fourth thing to see is "WHERE npc_list.zoneid = zone_settings.zoneid." When you're querying multiple tables, you need a way to logically connect the two so that the data can all be retrieved. In this case, that part of the query tells Navicat that npc_list's zoneid should match zone_setting's zoneid. And there's why we use itemId on so many tables; we can connect them that way.

The bonus, fifth thing to learn here is hex(look). This is just telling Navicat that the data in the "look" column should be displayed as hexadecimal. Since that's what it's stored in anyway, that actually makes it visible to you, instead of a mostly blank column.

Just how complex can this get?

SELECT mobname, mob_droplist.dropid, mob_droplist.itemid, item_basic.name, type, rate, zoneid, pos_x, pos_y, pos_z FROM mob_spawn_points, mob_groups, mob_droplist, item_basic WHERE mob_spawn_points.groupid = mob_groups.groupid AND mob_groups.dropid = mob_droplist.dropid AND mob_droplist.itemid = item_basic.itemid AND mob_droplist.itemid = 1044;

This particular query will return all mobs that drop item 1044 (oztroja_coffer_key).

==Lesson Four: Advanced SELECT Concepts==

What if we SELECTed results... from results of another SELECT? You can totally do that, and I'm terrible at it. So if you want to play around, here's a query to spend some time fiddling with.

SELECT mobname, mob_droplist.dropid, item_basic.name, mob_droplist.itemid, type, rate, zoneid, pos_x, pos_y, pos_z
FROM (SELECT mobname, zoneid, pos_x, pos_y, pos_z, dropid
FROM mob_groups, mob_spawn_points
WHERE mob_spawn_points.groupid = mob_groups.groupid AND mobname = "thunder_elemental"
GROUP BY mob_groups.groupid)
AS groups, mob_droplist, item_basic WHERE groups.dropid = mob_droplist.dropid AND mob_droplist.itemid = item_basic.itemid;

This query will retrieve the drops for any sets of the mob Thunder_Elemental. What I mean by that is that you'll only get one Thunder_Elemental for Sanctuary of Zi'Tah, although you'll get multiple rows because that mob has multiple drops.

I can only offer you two points here. First, the "AS unique_name" is necessary whenever you do this trick. Second, the GROUP BY near the end. This will return only one row for each result in the specified column(s).

==Lesson Five: INSERT==

INSERT queries put new data into a table. If the table is indexed and you try to use a duplicate index, the query will fail. There's two ways to INSERT: one at a time, or in bulk. One at a time looks like this:

INSERT INTO `npc_list` VALUES ('17277171', '_3e0', '0', '184.516', '-7.146', '14.297', '1', '40', '40', '9', '0', '0', '0', '4099', 0x0200000000000000000000000000000000000000, '0', '122');

INSERT INTO `npc_list` VALUES ('17277172', '_3e1', '0', '-184.516', '-7.146', '14.298', '1', '40', '40', '9', '0', '0', '0', '4099', 0x0200000000000000000000000000000000000000, '0', '122');

Because no columns are specified, it just starts inserting the data into each column, in order. If you come up short, then the columns are filled with their default value (if applicable.) If you have too many, your INSERT fails.

INSERT INTO `item_mods` (itemId, modId, value) VALUES (1,1,1), (2,2,2), (3,3,3), ... (1000,1000,1000);

I used an ellipsis to shorten things, but this query would insert 1000 rows into the item_mods table... or fail. These queries can actually be quite a bit faster than single inserts.

==Lesson Six: UPDATE and DELETE==

UPDATEs and DELETEs are easier to understand once you've got a grasp on SELECT. They do pretty much the same thing, except instead of listing results, they actually change or delete rows. Here's an example of each:

UPDATE weapon_skills SET skilllevel = 276 WHERE name IN ("ascetics_fury","atonement","kings_justice","insurgency","drakesbane","tachi_rana");

DELETE FROM item_mods WHERE itemid IN (13215, 13606) AND modid = 167;

There's only two things to keep in mind here. The first is that there's no "are you sure?" prompt. The second is that if you don't specify a condition, the query runs against everything. UPDATE item_basic SET name = 'kraken_club'; will rename everything to kraken_club. DELETE FROM chars; just deleted all of your characters, and thanks to the triggers on chars, it took out your inventory, levels, and more.

==Lesson Seven: Abusing Defaults to Customize Your Server==

Short lesson. Most values have default values, and sometimes they have these values for a reason. For example, char_points.windurst_supply has a default value of 0. That particular column stores which conquest teleports have been unlocked. And there's no reason you can't use Design Table to change that default to 12582880, which unlocks all Outpost Warps :)

Another example would be char_jobs.genkai, with a default of 50. This sets every new player's level cap to 50, until they've done quests with Maat. If you change that default to 75, then no new players will have to deal with Maat.

The only thing to consider in this situation is that some players might not want those enhancements. By placing them on an NPC, the player gets a choice between those spoils of war, and vanilla gameplay. However, it's your server, so make the choices you think are right.

==Lesson Eight: REPLACE Query==

The REPLACE query can be used to quickly copy records from a working copy of one table to a final copy. The syntax is as follows:

REPLACE INTO item_armor SELECT * FROM item_armor_copy;