esx_basicneeds

esx_basicneeds adds hunger and thirst to ESX Legacy. It registers both as statuses in esx_status, drains them over time, damages the player when one hits zero, and turns food and drink items (bread and water by default) into usable items with an eating or drinking animation.

OverviewCopy Anchor Link

How it behaves in-game:

• Hunger and thirst have a max of 1000000. Hunger drains 100 and thirst 75 per esx_status tick.
• At 0 the player takes damage each tick (1 HP, or 5 HP when health is at or below 150).
• After death and respawn both statuses are reset to 500000.
• Using an item adds status to hunger (food) or thirst (drink), plays a 3 second animation with an attached prop and optionally removes the item.

InstallationCopy Anchor Link

ensure esx_lib
ensure es_extended
ensure esx_status
ensure esx_basicneeds

ConfigurationCopy Anchor Link

Config.Items fieldsCopy Anchor Link

Config.Items['sandwich'] = {
    type = 'food',
    prop = 'prop_sandwich_01',
    status = 350000,
    remove = true,
    anim = { dict = 'mp_player_inteat@burger', name = 'mp_player_int_eat_burger_fp', settings = { 8.0, -8, -1, 49, 0, 0, 0, 0 } },
    pos = vector3(0.15, 0.03, 0.0),
    rot = vector3(15.0, 175.0, 5.0),
}

Remember to add sandwich to the items table as well.

CommandsCopy Anchor Link

/healCopy Anchor Link

/heal <playerId>

Admin only (admin group). Sets hunger and thirst to the maximum, restores full health and notifies the player. The playerId argument is required, so to heal yourself pass your own ID. Healing a player through the txAdmin menu triggers the same logic.

EventsCopy Anchor Link

esx_basicneeds:healPlayer (client)Copy Anchor Link

TriggerClientEvent('esx_basicneeds:healPlayer', playerId)

Sets hunger and thirst to 1000000 and health to max on that client. Net event, so trigger it from the server.

esx_basicneeds:resetStatus (client, local)Copy Anchor Link

TriggerEvent('esx_basicneeds:resetStatus')

Sets hunger and thirst to 500000. Local only, use it from client scripts (for example after a custom respawn).

esx_basicneeds:onUse (client)Copy Anchor Link

TriggerClientEvent('esx_basicneeds:onUse', playerId, itemType, propName, anim, pos, rot)

Plays only the animation; it does not change any status. Useful when your own script handles the item logic. Arguments are validated and a second call is ignored while an animation is running.

esx_basicneeds:isEating (client, local)Copy Anchor Link

TriggerEvent('esx_basicneeds:isEating', function(isEating)
    print('Eating or drinking:', isEating)
end)

Returns whether the eat or drink animation is currently playing.

Integration tipsCopy Anchor Link

• Change statuses from the server through esx_status. The server side only has esx_status:set and esx_status:add; to subtract, send the client event:

  Copy Text

  TriggerEvent('esx_status:add', source, 'hunger', 100000)
  TriggerClientEvent('esx_status:remove', source, 'thirst', 100000)

• Read the current value on the client:

  Copy Text

  TriggerEvent('esx_status:getStatus', 'hunger', function(status)
      print(status.percent)
  end)

• esx_optionalneeds adds a drunk status on top of these two.

Common issuesCopy Anchor Link

• Bars not showing: esx_status must start before esx_basicneeds, and Config.Visible must be true.
• Item does nothing: the item is missing from the items table, or type is not food or drink.
• Values reset on reconnect: esx_status saves statuses to the users.status column. Make sure that column exists.

RelatedCopy Anchor Link

• esx_status
• esx_optionalneeds
• esx_hud
• Add items

Frequently asked questions