Difference between revisions of "Items"

Revision as of 22:02, 4 April 2013

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

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

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.

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.

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

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.

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.

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.