HUD Docs
Présentation
Kairo HUD affiche les informations essentielles : santé, armure, faim, soif, oxygène, endurance, et en voiture la vitesse, le carburant et l'état du moteur. La mini-carte est retravaillée pour s'intégrer à l'ensemble.
Chaque joueur peut déplacer, redimensionner et masquer les éléments depuis le menu (/hud). Ses réglages sont enregistrés et retrouvés à la prochaine connexion.
Le HUD se met à jour seulement quand une valeur change : au repos, il reste sous 0,02 ms.
Installation
- Télécharge l'archive depuis « Mes achats » et décompresse-la.
- Place le dossier kairo-hud dans resources/[kairo]/ de ton serveur.
- Vérifie que kairo-core est démarré avant kairo-hud dans ton server.cfg.
- Ajoute la ligne ensure kairo-hud, puis redémarre le serveur. Les tables sont créées automatiquement au premier lancement.
# server.cfgensure kairo-coreensure kairo-hud
Configuration
Le fichier config.lua définit les éléments disponibles et leur position par défaut. Les joueurs partent de cette disposition, puis la modifient à leur goût.
-- config.luaConfig.Command = 'hud'Config.Unit = 'kmh' -- ou 'mph'Config.Minimap = { shape = 'square', zoom = 1.0 }Config.Components = { health = { enabled = true }, armor = { enabled = true }, hunger = { enabled = true }, thirst = { enabled = true }, stamina = { enabled = false },}
API
Les exports s'appellent avec exports['kairo-hud']:Nom(...). Les fonctions serveur ne sont jamais accessibles depuis le client.
SetVisible
clientexports['kairo-hud']:SetVisible(visible)
Masque ou réaffiche tout le HUD, par exemple pendant une cinématique ou un menu plein écran.
| Paramètre | Type | Description |
|---|---|---|
visible | boolean | true pour afficher |
Retour rien
exports['kairo-hud']:SetVisible(false)-- cinématique…exports['kairo-hud']:SetVisible(true)
SetComponent
clientexports['kairo-hud']:SetComponent(name, visible)
Affiche ou masque un seul élément.
| Paramètre | Type | Description |
|---|---|---|
name | string | Nom de l'élément (health, armor, hunger…) |
visible | boolean | true pour afficher |
Retour rien
exports['kairo-hud']:SetComponent('stamina', true)Notify
clientexports['kairo-hud']:Notify(message, kind, duration)
Petite notification intégrée au HUD.
| Paramètre | Type | Description |
|---|---|---|
message | string | Texte |
kind | string? | info, success, warning, error |
duration | number? | Durée en millisecondes (4000 par défaut) |
Retour rien
exports['kairo-hud']:Notify('Moteur coupé', 'warning')SetStatus
serveurexports['kairo-hud']:SetStatus(source, status, value)
Modifie une jauge d'un joueur (faim, soif…) depuis le serveur.
| Paramètre | Type | Description |
|---|---|---|
source | number | ID serveur |
status | string | hunger ou thirst |
value | number | Valeur de 0 à 100 |
Retour rien
exports['kairo-hud']:SetStatus(source, 'thirst', 100)Événements
kairo-hud:statusLow
clientUne jauge passe sous 15 %.
AddEventHandler('kairo-hud:statusLow', function(status) if status == 'thirst' then -- effet visuel endend)
Commandes
| Commande | Description |
|---|---|
/hud | Ouvre le menu de personnalisation. |
/hud reset | Remet la disposition par défaut. |
FAQ
Les jauges de faim et de soif baissent-elles toutes seules ?
Oui, à un rythme réglable dans config.lua. Elles remontent quand le joueur consomme un objet qui appelle SetStatus.
Le HUD fonctionne-t-il à la manette ?
Oui, le menu de personnalisation se pilote entièrement à la manette.