Item Object Documentation

getItem(itemID) -- Returns the global item data object for a given item ID.

item:getID() -- Returns the item's ID.
item:getName() -- Returns the item's name.
item:getRarity() -- Returns the item's rarity.
item:getPricedRarity() -- Returns numeric rarity based on real-GT prices (0-7, higher = more rare).
item:getActionType() -- Returns the item's action type (e.g., clothing, seed).
item:getCategoryType() -- Returns the category type of an item.
item:getEditableType() -- Returns the editable type of an item.
item:getClothingType() -- Returns the clothing type of the item.
item:getNetID() -- Returns the item's net ID.
item:getTexture() -- Returns the texture name that the item uses (string).
item:getTextureX() -- Returns the X coordinate of the texture (number).
item:getTextureY() -- Returns the Y coordinate of the texture (number).

local item = getItem(242) -- World Lock
local rarity = item:getPricedRarity()
 
-- Rarity scale: 0 = no info, 1-7 = increasing rarity
-- Higher numbers mean more rare/expensive items
if rarity >= 5 then
    print("This is a very rare item!")
elseif rarity == 0 then
    print("No rarity information available")
end

item:getGrowTime() -- Returns the item's grow time in seconds.
item:setGrowTime(seconds) -- Sets the grow time for an item globally.
item:setActionType(type) -- Sets the action type for an item globally.
item:setCategoryType(value) -- Sets the category type of the item globally.
item:setClothingType(typeID) -- Sets the clothing type ID of the item globally.
item:setEditableType(value) -- Sets the editable type of the item globally.

item:setDescription(text) -- Sets the description for an item globally.

item:setPrice(price) -- Sets the price of the item.
item:isObtainable() -- Returns true if the item is obtainable.
item:getObtainability() -- Returns info about where the item can be obtained (like book of knowledge).

item:getEffects() -- Returns table with item's effects from item manager.
item:setEffects(data) -- Sets item effects without needing to restart server.

local item = getItem(98) -- Pickaxe
 
-- Get current effects
local effects = item:getEffects()
print("Current extra gems: " .. effects.extra_gems)
 
-- Set new effects (automatically saves to item effects panel in dashboard)
item:setEffects({
    extra_gems = 500,
    extra_xp = effects.extra_xp,
    one_hit = effects.one_hit,
    break_range = effects.break_range,
    build_range = effects.build_range
})
 
-- Verify changes
local newEffects = item:getEffects()
print("New extra gems: " .. newEffects.extra_gems)

item:getGems(world, player) -- Returns the number of gems an item would drop, optionally considering player buffs.
item:getXP(world, player) -- Returns the amount of XP an item would give, optionally considering player buffs.