> ## Documentation Index
> Fetch the complete documentation index at: https://mythicframework.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Status - Exports
> Server and client status system for hunger, thirst, stress, and custom statuses
The Status component manages player statuses like hunger, thirst, stress, and drunkenness. It has both server and client components — the server tracks persistence while the client handles visual display and effects.
## Overview
Access via `Status` on both server and client.
Hunger, Thirst, Stress, Drunk
Register your own status types
HUD display, blur, shake effects
Saved to character data
***
## Server-Side Methods
**Server-side** Status methods manage data persistence. The **client** handles visual display and modification logic. Use `Execute:Client` or events to trigger client-side changes from the server.
### Status:Register (Server)
Register a status type on the server.
```lua theme={null}
Status:Register(name, max, icon, tick, modify)
```
Status identifier (e.g., `'PLAYER_HUNGER'`)
Maximum value
Icon identifier
Callback for tick logic
Callback for modification logic
***
### Status.Get:All (Server)
Get all registered status definitions.
```lua theme={null}
Status.Get:All()
```
All registered status definitions
***
### Status.Get:Single (Server)
Get a single status definition.
```lua theme={null}
Status.Get:Single(name)
```
Status name
***
### Status:Set (Server)
Set a status value for a player and sync to client.
```lua theme={null}
Status:Set(source, name, value)
```
Player server ID
Status name
New value
**Example:**
```lua theme={null}
-- Reset a player's hunger to full
Status:Set(source, 'PLAYER_HUNGER', 100)
-- Set stress to zero
Status:Set(source, 'PLAYER_STRESS', 0)
```
***
### Status.Modify:Add (Server)
Add to a status value via client callback.
```lua theme={null}
Status.Modify:Add(source, name, value, addCd, isForced)
```
Player server ID
Status name
Amount to add
Add cooldown after modification
Force the modification (bypass checks)
**Example:**
```lua theme={null}
-- Feed the player (restore hunger)
Status.Modify:Add(source, 'PLAYER_HUNGER', 25)
-- Hydrate the player
Status.Modify:Add(source, 'PLAYER_THIRST', 30)
```
***
### Status.Modify:Remove (Server)
Remove from a status value via client callback.
```lua theme={null}
Status.Modify:Remove(source, name, value, addCd, isForced)
```
**Example:**
```lua theme={null}
-- Add stress
Status.Modify:Remove(source, 'PLAYER_STRESS', 15)
-- Sober up
Status.Modify:Remove(source, 'PLAYER_DRUNK', 20)
```
For inverted statuses like Stress and Drunk (where higher = worse), `Remove` decreases the value and `Add` increases it. Use `Remove` to reduce these statuses.
***
## Client-Side Methods
### Status:Register (Client)
Register a status with visual properties for the HUD.
```lua theme={null}
Status:Register(name, max, icon, color, flash, modify, options)
```
Status identifier
Maximum value
FontAwesome icon name
Hex color code for HUD display
Enable flash animation when low
Callback for value changes: `function(change, force)`
Display options (see Options below)
***
### Status.Get:All (Client)
Get all statuses with their current values.
```lua theme={null}
Status.Get:All()
```
All statuses with current values from `LocalPlayer.state`
***
### Status.Get:Single (Client)
Get a single status with current value.
```lua theme={null}
Status.Get:Single(name)
```
***
### Status.Set:All (Client)
Set all statuses to a specific value.
```lua theme={null}
Status.Set:All(entity, value)
```
***
### Status.Set:Single (Client)
Set a single status to a specific value.
```lua theme={null}
Status.Set:Single(name, value)
```
**Example:**
```lua theme={null}
-- Client-side: Set hunger to full
Status.Set:Single('PLAYER_HUNGER', 100)
```
***
### Status.Modify:Add (Client)
Add to a status value on the client.
```lua theme={null}
Status.Modify:Add(status, value, addCd, force)
```
***
### Status.Modify:Remove (Client)
Remove from a status value on the client.
```lua theme={null}
Status.Modify:Remove(status, value, force)
```
***
### Status:Reset
Reset all resettable statuses to their maximum value.
```lua theme={null}
Status:Reset(entity, value)
```
Statuses with `noReset = true` (like Stress and Drunk) are not affected by Reset.
***
### Status:Toggle
Toggle the status system on or off.
```lua theme={null}
Status:Toggle()
```
***
### Status:Check
Check if the status system is currently enabled.
```lua theme={null}
Status:Check()
```
`true` if status system is active
***
## Options Structure
```lua theme={null}
{
id = 1, -- HUD position priority (lower = further left)
hideHigh = false, -- Hide the status icon when at max value
hideZero = false, -- Hide the status icon when at zero
inverted = false, -- Inverted display (fills right to left, higher = worse)
noReset = false -- Won't reset when Status:Reset is called
}
```
***
## Status Storage
* **Character Data:** `Character:SetData("Status", { PLAYER_HUNGER = 100, ... })`
* **State Variables:** `LocalPlayer.state["status:PLAYER_HUNGER"]`
* **HUD Display:** Registered via `Hud:RegisterStatus()`
***
## Best Practices
```lua theme={null}
-- ✅ Good: Server sets status (persists and syncs)
Status:Set(source, 'PLAYER_HUNGER', 100)
-- ❌ Bad: Client-only change (won't persist on disconnect)
-- Only use client methods for temporary visual effects
```
```lua theme={null}
-- Hunger/Thirst: 100 = full, 0 = starving (normal)
-- Stress/Drunk: 0 = sober, 100 = max (inverted)
-- To feed a player:
Status.Modify:Add(source, 'PLAYER_HUNGER', 25)
-- To reduce stress:
Status.Modify:Remove(source, 'PLAYER_STRESS', 10)
```
***
## Next Steps
Built-in status types and effects
HUD display system
Character data access