en-consumables

en-consumables decides what eating, drinking and medicine actually do. When you use a food, drink, medical or armour item, you play an animation with a prop in hand and see a progress bar you can cancel. The item is only taken, and its effects applied, if the bar finishes.

Items can restore hunger and thirst, heal you, set armour, purge radiation, treat infection or boost immunity. They can also apply effects over time, like a course of antibiotics, give you a temporary stamina boost, or carry a risk of making you sick (murky water, dodgy burgers). The Medicine skill makes healing stronger, and the Iron Gut perk lowers the chance of getting sick.

#At a glance

#How it works

#Using an item

Every key in Config.items is registered as a usable item in en-inventory. When a player uses one:

1. The server checks the player isn't dead and isn't within Config.cooldown of their last use.
2. The client plays the animation and progress bar. You can't use items while swimming, ragdolled or dead.
3. If the bar completed, the server removes the item, then applies the effects. If the item is already gone, nothing happens.

The server rejects a "finished" reply that arrives in less than 80% of the item's duration, and gives up waiting after 30 s.

#Effects

Effects change en-core's survival stats; see Survival system.

• Positive health is multiplied by 1 + healing bonus. It's given on a 0–100 scale and converted to the ped's real health range on the client.
• armour sets armour to at least that value, scaled by the item's metadata.durability.
• Negative hunger, thirst, radiation and infection values remove that amount.

#Effects over time

An overTime block repeats its effects every interval seconds, ticks times. Using the same item again restarts the course rather than stacking it. A course stops if the player dies or unloads.

#Risk

After use, a risk block rolls this chance:

chance = risk.chance * (1 - math.min(0.9, foodRiskBonus))

If it hits, the player gets the listed infection or radiation and sees risk.message.

#Configuration

#Item fields

#Default items

#Adding consumables

Config.items.boiled_rice = {
    label = 'Eating rice', duration = 5000, animation = 'eatCan',
    effects = { hunger = 40, thirst = -8 },
}

Config.items.raw_meat = {
    label = 'Eating raw meat', duration = 6000, animation = 'eat',
    effects = { hunger = 25 },
    risk = { chance = 0.5, infection = 12, message = 'You shouldn\'t have eaten that raw.' },
}

Config.items.morphine = {
    label = 'Injecting morphine', duration = 4000, animation = 'pill', walk = false,
    effects = { health = 20 },
    overTime = { interval = 5, ticks = 10, health = 4 },
}

#Exports

#Server

#Client

#Events

en-skills uses en-consumables:server:consumed to award Medicine XP for medical items.

#Examples

A medic NPC that patches players up without using an item:

-- server
AddEventHandler('mymedic:server:treat', function()
    local source = source
    exports['en-consumables']:ApplyEffects(source, { health = 60, infection = -25, immunity = 10 }, 'medic')
end)

Stop players from opening your menu mid-bite:

-- client
RegisterCommand('mymenu', function()
    if exports['en-consumables']:IsBusy() then return end
    -- open the menu
end)

Track what players eat:

AddEventHandler('en-consumables:server:consumed', function(source, itemName, definition)
    if definition.risk then
        print(('%s risked eating %s'):format(GetPlayerName(source), itemName))
    end
end)

#Related

• Survival system
• en-skills
• Add an item
• en-inventory