Log inGet started
World

Pack Rat: Inventory, Loot and Equipment Kit

README.md

inventoryItem (dataType contract)

One item a game can carry: a sword, a potion, a key. Every .data asset bound to this contract is an item inventoryKit finds by itself, in the kit and anywhere in the game's own world, so adding an item is adding one data asset and no code.

FieldMeaning
idThe stable id saves and code use (sword, healthPotion). Never change it once players have the item.
name, descriptionWhat the screens show.
kindweapon, armour, consumable, material, key, ammo, currency or misc; screens group and filter by it.
slotThe equipment slot it goes in: head, chest, legs, feet, hands, mainHand, offHand, accessory, or empty for items that are not worn.
maxStackHow many fit in one slot (1 = does not stack).
raritycommon, uncommon, rare, epic or legendary; picks the slot's rarity frame.
iconFantasy, iconScifiThe icon texture in each look. If one is missing the other is used.
modelThe bundle shown on the ground and when worn or held.
sizeThe model's longest side in metres; the kit scales the model to it.
weight, valueShown by the survival list; the kit enforces neither.
useEffect, useAmount, useDurationWhat using it does: heal (health, through SecondWind), mana, shield, speed (a speed power-up for useDuration seconds), bomb (a blast that damages everything near), event (only the use event fires). A used consumable loses one from its stack.
wearOnA humanoid socket to wear it on instead of its slot's usual one (leftindex1 puts a ring on a finger).
holdFine placement when worn or held: position (metres), rotation (degrees pitch, yaw, roll) and scale.
tagsFree words a game can filter by.