Item

Configuration schema and parameter reference for standard and consumable inventory items.

Item Definition

Define standard items and consumables in shared/items.lua:

["water"] = {
    name = "water",
    label = "Water",
    weight = 1000,
    type = "item",      -- "item", "backpack"
    durability = 1.0,   -- 1 hour
    decay = true,       -- Removed when item quality reaches 0
    close = true,       -- Close inventory UI on item use
    limit = 100,        -- Total inventory quantity limit
    stacksize = 10,     -- Maximum stack quantity per slot

    client = {
        onUse = function(item)
            -- Executes on client when item is used
        end,
        onAdd = function(item)
            -- Executes on client when item is received
        end,
        onRemove = function(item)
            -- Executes on client when item is removed
        end,
        TriggerEvent = 'Your Trigger Name Here',
        TriggerServerEvent = 'Your Server Trigger Name Here',
    },
    server = {
        onUse = function(source, item)
            -- Executes on server when item is used
        end,
        onAdd = function(source, slot)
            -- Executes on server when item is received
        end,
        onRemove = function(source, slot)
            -- Executes on server when item is removed
        end,
        TriggerEvent = 'Trigger Name Here',
        TriggerClientEvent = 'Your Client Trigger Name Here',
    },

    consume = {
        attachment = {
            prop = 'prop_ld_flow_bottle',
            bone = 18905,
            position = vector3(0.12, 0.008, 0.03),
            rotation = vector3(240.0, -60.0, 0.0)
        },
        animation = {
            dict = 'mp_player_intdrink',
            anim = 'loop_bottle',
            blendIn = 2.0,
            blendOut = 2.0,
            flag = 49,
        },
        progress = {
            label = 'Drinking Water',
            disable = {
                car = false,
                combat = false,
                move = false,
            }
        },
        status = {
            hunger = 50,
            thirst = 50,
            stress = 25,
        },
        delay = 5000,
        remove = 0.4, -- Value of 1 removes item; 0.4 reduces quality by 40%
    }
},

Schema Parameters