Metadata - Jaksam's Scripts

How to show metadata to players

Showing specific metadata to players is easy. First of all, you’ll need to know what the metadata key is that you want to show. To do so, you can enable “Debug mode” in the /inventory settings menu, then hover the item you want to see the metadata of.

Adding it to a single item

To show players the metadata of a single item, you can add and adapt this code in the single item definition, in the jaksam_inventory/_data/items.lua file:

displayFields = {
    { field = 'YOUR_METADATA_KEY_HERE', label = 'TEXT YOU WANT HERE: ${value}'}, -- Random example
    { field = 'ammo', label = 'Ammo: ${value}'}, -- Useful on weapons (already built in by default)
    { field = 'plate', label = 'Plate: ${value}'}, -- Useful on carkeys
},

Adding it to all item types

To show players the metadata of an entire item type, it’s 100% the same method, but place it in the Script.defaultsByType table, in the jaksam_inventory/_data/defaults.lua file.

Optional: Making metadata values look nicer

Sometimes you want to show metadata in a prettier way to players. For example, instead of showing “weapon_pistol”, you want to show “Pistol”. This is where formatters come in!

A formatter is like a translator: it takes the original value (e.g. weapon_pistol) and converts it to something nicer (e.g. Pistol).

You can use built-in formatters or create your own custom ones in jaksam_inventory/_data/formatter.lua. Here’s how to use them:

displayFields = {
    { field = 'item', label = 'Label: ${value}', formatterId = "itemNameToLabel"}, -- An example with built in formatter
},

How to set default metadata for items

Want items to have certain metadata values when they’re first created? For example, maybe you want new weapons to start with 50% durability. Here’s how to do it:

Open the admin menu

Type /inventory in-game to open the admin menu.

Find the item

Find and click on the item you want to edit.

Open the metadata tab

Click on the “metadata” tab.

Set values

Set the metadata values you want.

Advanced - Using templates for dynamic metadata

Sometimes you want metadata that changes based on certain conditions. For this, you can use templates:

Open the metadata tab

Go to the same metadata tab in the item editor.

Switch to template type

Change the metadata type to template.

Choose or create a template

Either select an existing template, or create your own in jaksam_inventory/_data/metadata_templates.lua.

Templates let you create metadata that updates automatically based on rules you define!

Example

Some examples of what you can do with dynamic metadata templates:

Assign a player’s Identification Card their name, birth date, height, etc.
Assign a random durability to a weapon
Assign the creation date to an item (the first time the item is created)

​How to show metadata to players

​Adding it to a single item

​Adding it to all item types

​Optional: Making metadata values look nicer

​How to set default metadata for items

​Advanced - Using templates for dynamic metadata

​Example

How to show metadata to players

Adding it to a single item

Adding it to all item types

Optional: Making metadata values look nicer

How to set default metadata for items

Advanced - Using templates for dynamic metadata

Example