en-shops

en-shops puts NPC traders at settlements and checkpoints. Walk up to a trader and talk to them, either with the look-target or with the E prompt when targeting is off. The camera focuses on them, they greet you, and a trade page opens.

Traders sell goods for cash or for barter (other items, per unit). Some offers are barter-only, and offers can be locked behind a character level or a skill level. Traders also buy scavenged goods, either by item category or by item name.

Prices follow stock. Each trader holds limited stock of each item, which restocks over time. They charge more as a shelf empties and pay less for things they've already bought a lot of. The server makes every decision.

#At a glance

#How it works

#Trader peds

Trader peds are spawned client-side within 80 m. They are invincible and frozen, and can play a scenario. You must be within Config.distance to trade.

#Buying

A buy is paid in cash or by barter. Cash buys are refunded if the item doesn't fit in your inventory. A barter buy removes each cost item (count * amount), and everything is rolled back if a step fails. An offer's requires checks your character level (see XP and levels) or a skill level from en-skills.

#Selling

The sell tab lists everything you carry that this trader will buy. If you sell an item the trader also stocks, it goes back on their shelf, up to max.

#Pricing

Buy price:

price = math.max(1, round(base * (1 + (1 - stock / max) * Config.pricing.scarcity)))
-- base = offer.price or Config.values[item] or 1

Sell price, per unit:

price = math.floor(value * rate * (1 - math.min(maxDrop, holdings / saturation * maxDrop)))
-- rate = trader.buys.rate or Config.pricing.sellRate

The sell price is 0 if the trader doesn't accept the item or it has no value.

#Restocking

Every Config.restock.minutes, each shelf gains ceil(max * refill) stock and each trader's holdings are multiplied by 1 - clearance. Stock and holdings are saved to the database every 60 s and when the resource stops.

#Configuration

#Trader fields

Each entry in sells:

#Adding a trader

Config.traders[#Config.traders + 1] = {
    id = 'vinewood_fence',
    label = 'Vinewood Fence',
    name = 'Marta',
    greeting = { 'Quick. What have you got?', 'No questions, no refunds.' },
    ped = { model = 'a_f_y_hipster_02', coords = vec4(300.2, 180.4, 104.1, 70.0), scenario = 'WORLD_HUMAN_SMOKING' },
    blip = { sprite = 52, colour = 47 },
    sells = {
        { item = 'lockpick', max = 10 },
        { item = 'ammo_rifle', max = 120, barter = { { item = 'scrapmetal', count = 2 } }, requires = { level = 6 } },
        { item = 'gps', max = 2, barterOnly = true, barter = { { item = 'radio', count = 1 }, { item = 'duct_tape', count = 2 } } },
    },
    buys = { categories = { 'weapon', 'tool' }, items = { 'radio' }, rate = 0.5 },
}

#Exports

All exports are server-side. There are no client exports.

#Commands

#Events

Server-local events:

The trade page closes on encore:client:playerDied and encore:client:playerUnloaded.

#Database

encore_shop_stock: trader VARCHAR(60), item VARCHAR(60), stock INT, holdings INT. The primary key is (trader, item).

#Examples

Show a trader's live price in your own UI:

-- server
local price = exports['en-shops']:GetBuyPrice('sandy_scrapper', 'scrapmetal')
local stock = exports['en-shops']:GetStock('sandy_scrapper', 'scrapmetal')

if price then
    print(('Scrap metal: $%d (%d in stock)'):format(price, stock))
end

Restock a trader when a supply convoy arrives:

AddEventHandler('myconvoy:server:arrived', function(traderId)
    exports['en-shops']:Restock(traderId)
end)

Track what players sell:

AddEventHandler('en-shops:server:sold', function(source, traderId, item, amount, totalCash)
    print(('%s sold %dx %s to %s for $%d'):format(GetPlayerName(source), amount, item, traderId, totalCash))
end)

#Related

• Add a trader
• Money and cash
• en-inventory
• en-admin