Skip to main content

Item Definition Reference

The normalized definition supports these core fields:

Field Purpose
label Player-facing item name
description Item description
weight Weight per unit
volume Optional volume value
stack Allow stacking when metadata matches
close Close inventory on use
category Registry/UI category
image Local filename/path or HTTP(S) URL
schema Item schema name
unique Force separate instances
metadataDefaults Default metadata object
metadataSchema Metadata field definitions
metadataDisplay Player metadata visibility
container Container storage definition
consume hunger/thirst/health/armor effects
use duration, movement, animation, prop, removal
weapon GTA weapon name
worldModel Ground/world prop model
durability Per-instance durability rules
expiry Per-instance shelf life
clientEvent Trusted file/runtime definition event
serverEvent Trusted file/runtime definition event

Use block limits

Normalized use configuration supports:

use = {
    duration = 0,              -- 0..30000 ms
    allowMove = true,
    cancelable = true,
    remove = 0,                -- 0..100
    actionText = 'Using {item}',
    animation = {
        dict = '...',
        clip = '...',
        flag = 49              -- normalized 0..51
    },
    prop = {
        model = 'prop_name',
        bone = 60309,
        pos = { x=0, y=0, z=0 },
        rot = { x=0, y=0, z=0 },
        rotOrder = 0           -- 0..5
    }
}

Container limits

container = {
    slots = 20,        -- normalized 1..200
    maxWeight = 25000  -- normalized 1000..2000000
}

Weapon format

weapon = {
    name = 'WEAPON_PISTOL'
}

The name must match the WEAPON_* format.

Back to top