Items

Last updated on

Catalogue files

• Items: modules/inventory/data/items.lua (M.Data.ITEMS). Weapons: modules/inventory/data/weapons.lua (M.Data.WEAPONS).
• The key is the item name: letters, digits, _, - and ., up to 48 bytes.
• A malformed row is a boot warning and is left out.
• No way to add items at runtime.

Item fields

water = {
    WEIGHT = 500, CATEGORY = 'drink', MODEL = 'food.drink_packaged',
    USE = { STATUS = { thirst = 35 }, ANIMATION = { NAME = 'drink', DURATION_MS = 3000 } },
},

USE sub-fields:

An item with neither USE nor a registered use handler cannot be used (not_usable).

Weapons as items

M.Data.WEAPONS has three tables:

AMMO = { ammo_handgun = { WEIGHT = 10, MAX = 500, MODEL = 'crate.ammo_box' } },
CLASSES = { handgun = { AMMO = 'ammo_handgun', MODEL = 'military.case', MAGAZINE = 15 } },
WEAPONS = { weapon_chao = { RECORD = 'Items.Preset_Chao_Default', CLASS = 'handgun', WEIGHT = 1000 } },

• A weapon is never stackable. Each unit gets metadata { serial, ammo }: a serial of two letters and eight hex digits, and ammo = 0. A serial passed in metadata is kept only when one weapon is added.
• Using a weapon draws it into game weapon slot WEAPONS.SLOT. Using it again puts it away. Moving, giving or dropping a drawn weapon first puts it away and reads its rounds: that try is refused with holstering, the next one goes through with the right ammo. Other modules put it away with HolsterWeapon.
• Using an ammunition item loads it into the drawn weapon of the matching class, up to the weapon's MAGAZINE (or its class's). The rounds are kept on the weapon's ammo metadata and read back from the game every WEAPONS.AMMO_SYNC_MS; they only ever go down that way.
• With WEAPONS.REMOVE_UNBACKED = true, any equipped weapon no bag item backs is taken off the player every WEAPONS.SCAN_MS.
• Drawing a weapon needs the host's Open77.weapons relay. Without it the use answers weapons_unavailable.

Shipped items

• Drinks, food, medical items (they heal: HEALING), materials (scrap_metal, electronics), lockpick, hauling_crate (10 kg, used by hauling), phone, id_card, shard, vehicle_key, eddies, four ammunition types and 189 weapons.
• vehicle_key is non-stackable and carries metadata { plate, label }, written by vehiclekeys. The screen and the hotbar show a stack's own metadata.label when it has one. Use CountWhere to find a key by plate.
• door_key is non-stackable, has no USE and carries metadata { type, label }, cut by doorlock. A door that lists { name = 'door_key', metadata = '<type>' } opens for a key of that type.

Pile models

Every droppable item names the nearest prop the platform hosts. The alias list is compiled into the Open77 client, so a resource cannot add one; most non-food items draw a stand-in.

shard = { WEIGHT = 20, MODEL = 'crate.valuable' }, -- an alias name, never a .mesh path

• A weapon's own MODEL wins over its class's.
• Decorative weapons (a pile that looks like the weapon itself) are not possible from a resource: a raw .mesh draws as a marker, a raw .ent is refused (template_backend_disabled), and nothing registers a new alias. It needs one alias per weapon family in the platform. The note is at the top of data/weapons.lua.