PLUGIN plugin

Implements hook GetBars

Called to add HUD bars; adds the hunger bar, with thirst as its second value, below 90 hunger.

Parameters

• bars Map The HUD bars being built

Implements hook OnePlayerSecond

Called every second for each player; drains the needs of players with needs and applies their effects.

Hunger and thirst fall so that they empty over the hunger_tick and thirst_tick configs in seconds, and hunger is never above thirst. Fatigue rises over 20000 seconds. Starving players slowly lose health down to 50 (below 15 hunger) or 20 (below 5), and players above 85 fatigue fall asleep for 30 seconds while alive. The values are networked as the Hunger, Thirst and Fatigue net vars.

Parameters

• player Player The player
• curTime Number The current time
• infoTable Map The player's info table

Implements hook PlayerHasNeeds

Called to check whether a player gets hungry, thirsty and tired.

Everyone but the Combine has needs; Civil Protection have them too.

Parameters

• player Player The player to check

Returns

• Boolean Whether the player has needs

Implements hook PlayerRestoreCharacterData

Called when character data is restored; defaults hunger and thirst to 100 and fatigue to 0.

Parameters

• player Player The player whose character is loading
• data Character The character data, modified in place

Implements hook PlayerSaveCharacterData

Called when character data is saved; rounds the hunger, thirst and fatigue values.

Parameters

• player Player The player being saved
• data Character The character data to save, modified in place

Implements hook PlayerShouldHealthRegenerate

Called to check whether a player's health regenerates; blocks it below 65 hunger.

Parameters

• player Player The player to check

Returns

• Boolean false to block regeneration, otherwise nil

Implements hook PlayerShouldStaminaRegenerate

Called to check whether a player's stamina regenerates; blocks it below 30 thirst.

Parameters

• player Player The player to check

Returns

• Boolean false to block regeneration, otherwise nil

Implements hook PlayerThink

Called every player think; jumping and running in the air tire a player with needs and drain thirst.

Thirst drains by the thirst_drain_scale config, in hundredths, per think.

Parameters

• player Player The player thinking
• curTime Number The current time
• infoTable Map The player's info table for this think, with isJumping and isRunning

Implements hook PlayerUseItem

Called after a player uses an item; feeds them when it is food or drink.

Applies to items with a hunger, thirst or fatigue field and to items in a consumables, alcohol, UU-branded or food category. Missing values default to the hunger_default_refill config. Drinks (a thirst field or "water" in the name) refill thirst and only 40% of the hunger value; a fatigue field reduces fatigue. Saves the character afterwards.

Parameters

• player Player The player who used the item
• itemTable Item The item used

Implements hook PostPlayerSpawn

Called after a player spawns; resets their needs on a respawn that is neither the first nor a light spawn.

Parameters

• player Player The player that spawned
• lightSpawn Boolean Whether this was a light spawn
• changeClass Boolean Whether the player changed class
• firstSpawn Boolean Whether this is the character's first spawn