Personnalisation
Les paramètres se trouvent dans config.lua. Les fichiers qui communiquent avec votre framework, votre inventaire et votre ressource de target sont laissés ouverts, de sorte qu’un serveur qui fonctionne différemment puisse les adapter sans toucher au cœur sous escrow.
Quel fichier décide de quoi
Section intitulée « Quel fichier décide de quoi »| Fichier ou dossier | Ce qu’il décide | Ouvert ? |
|---|---|---|
config.lua | Chaque paramètre de cette page, la fonction de notification, les items et les saveurs | Ouvert |
locales/*.lua | Tous les textes : menu, libellés du target, messages. Un fichier par langue | Ouvert |
server_functions.lua | Obtenir un joueur, ajouter, retirer et vérifier des items, enregistrer les items utilisables, le callback des saveurs, et ReduceStress | Ouvert |
client/client_functions.lua | Lecture des données du joueur, et vérification du job pour le menu de configuration | Ouvert |
target/target.lua | Toutes les options de target sur les chichas et les meubles, pour ox_target et qb-target | Ouvert |
client/client.lua, server/server.lua, locale.lua | Placement, tuyau, fumée, propriété et fournitures | Sous escrow |
html/ | Le menu de configuration : index.html, style.css, script.js | Fichiers en clair |
inventory_items/ | Définitions d’items prêtes à l’emploi pour ESX, ox_inventory et QBCore | Référence |
inventory_images/ | Une icône par item | Assets |
mic_hookah_prop/stream/ | Les dix modèles de chichas | Assets, ressource séparée |
Framework, target et images
Section intitulée « Framework, target et images »| Option | Ce qu’elle fait | Par défaut |
|---|---|---|
Config.Locale | Langue | en |
Config.Framework | esx, qbcore ou qbox | esx |
Config.ESXResourceName | Nom de dossier d’ESX | es_extended |
Config.QBResourceName | Nom de dossier de QBCore | qb-core |
Config.QBoxResourceName | Nom de dossier de QBox | qbx_core |
Config.Target | ox_target ou qb-target | ox_target |
Config.QBTargetResourceName | Nom de dossier de qb-target | qb-target |
Config.InventoryImagePath | D’où le menu charge les icônes des saveurs | nui://ox_inventory/web/images/ |
| Option | Ce qu’elle fait | Par défaut |
|---|---|---|
Config.AdminGroups | Groupes autorisés à ouvrir le menu et ramasser n’importe quelle chicha ou meuble. false signifie que tout le monde est admin | false |
Config.AllowedJobs | Jobs autorisés à ouvrir le menu de configuration. false signifie n’importe quel job | false |
Par défaut, n’importe qui peut gérer la chicha de n’importe qui. Pour que chaque chicha appartienne au joueur qui l’a posée, listez vos groupes de staff dans Config.AdminGroups — par exemple admin et superadmin. Sur ESX, la liste est comparée au groupe du joueur ; sur QBCore et QBox, au champ permission du joueur.
Avec une liste configurée :
| Qui | Open Setup Menu | Ramasser | Grab Hose |
|---|---|---|---|
| Le joueur qui l’a posée | oui (si son job est autorisé) | oui | oui |
| Un groupe admin | oui (si son job est autorisé) | oui | oui |
| N’importe qui d’autre | non | non | oui |
Config.AllowedJobs ne protège que le menu de configuration. N’importe qui peut attraper le tuyau et fumer une chicha allumée.
Consommation et fournitures
Section intitulée « Consommation et fournitures »| Option | Ce qu’elle fait | Par défaut |
|---|---|---|
Config.MaxActiveTime | Ce que signifie « plein » pour le charbon et l’eau. Un hookah_coal ou hookah_water le remplit à cette valeur | 1800 |
Config.ConsumptionPerPuff | Quantité retirée au charcoal et à l’eau (water) par bouffée | 10 et 10 |
Config.MaxPuffsPerSession | Calculé à partir des deux valeurs ci-dessus (1800 ÷ 10 = 180). Donné pour référence ; le script ne le lit pas | 180 |
Config.MaxHoseDistance | Distance en mètres avant que le tuyau ne se rompe | 3.5 |
Config.MaxSimultaneousUsers | Limite prévue de personnes fumant sur la même chicha | 4 |
Config.Stress | Appelle ReduceStress à chaque bouffée | true |
La chicha ne se consume pas avec le temps : le charbon et l’eau diminuent uniquement lorsque quelqu’un tire une bouffée. Lorsque l’un ou l’autre tombe à zéro, la chicha s’éteint et nécessite une recharge.
ReduceStress dans server_functions.lua reçoit l’ID serveur du joueur à chaque bouffée lorsque Config.Stress est activé. Il est livré vide, avec des exemples commentés : un événement client, un export ou un événement serveur de votre ressource de stress ou de HUD. Placez votre appel à cet endroit.
| Option | Ce qu’elle fait | Par défaut |
|---|---|---|
Config.Particle | Particule utilisée : un dict et un name | scr_recartheft / scr_wheel_burnout |
Config.VapeExhale | Taille de la fumée | 0.5 |
La configuration signale ces deux paramètres par « ne modifiez pas à moins de savoir ce que vous faites ». Chaque nuage dure trois secondes et est visible par les joueurs situés à moins de 150 mètres.
Chichas, meubles et saveurs
Section intitulée « Chichas, meubles et saveurs »Les listes complètes se trouvent sur 🎒 Items.
Config.HookahItems — nom de l’item → modèle. Pour ajouter une chicha, le modèle doit être streamé (par exemple dans mic_hookah_prop/stream/ avec une entrée dans son .ytyp), puis ajoutez la ligne ici et l’item dans votre inventaire.
Config.PlaceableProps — nom de l’item → propModel, type (furniture) et isChair. Tout prop du jeu de base fonctionne. Définissez isChair = true pour tout élément devant proposer Sit Down.
Config.Flavors — nom de l’item → paramètres :
| Champ | Ce qu’il fait |
|---|---|
Label | Nom affiché dans le menu de configuration |
SmokeColor | Couleur R, G, B de la fumée |
ScreenEffect | Nom d’un effet d’écran GTA appliqué au fumeur, ou false pour aucun |
EffectDuration | Durée en secondes de l’effet d’écran |
La configuration fournit un lien vers une liste d’effets d’écran à côté de Config.Flavors. Pour ajouter une saveur, copiez une entrée, donnez-lui un nouveau nom d’item, puis ajoutez l’item et son icône dans votre inventaire.
Notifications
Section intitulée « Notifications »Config.Notify dans config.lua envoie chaque message : ShowNotification sur ESX, Functions.Notify sur QBCore et QBox, la console sinon. Remplacez son contenu pour utiliser votre propre ressource de notifications.
Onze fichiers sont fournis dans locales/ : en, es, fr, de, it, pt, ru, cn, nl, pl, tr. Choisissez-en un avec Config.Locale.
Le commentaire au-dessus de Config.Locale mentionne également jp, mais aucun fichier japonais n’est fourni ; le définir affichera « Locale [jp] does not exist ».
Chaque fichier couvre le menu de configuration, les libellés du target et les messages. Quelques mots sont codés en dur dans le Lua plutôt que dans les fichiers de langue : les indications de placement (Rotate Right, Rotate Left, Height Up, Height Down, Place Prop, Cancel), « You are already placing an object », et « None » pour une saveur vide.
Pour ajouter une langue : copiez locales/en.lua, remplacez la clé au début par votre code et traduisez. Le manifest charge automatiquement tout ce qui se trouve dans locales/, il n’y a donc rien d’autre à déclarer. Définissez Config.Locale, faites refresh et redémarrez.
Adapter le script à votre serveur
Section intitulée « Adapter le script à votre serveur »| Pour modifier | Éditer |
|---|---|
| Un framework sur mesure | L’objet de framework au bas de config.lua, ainsi que les fonctions dans server_functions.lua et client/client_functions.lua |
| Un inventaire différent | AddItem, RemoveItem et HasItem dans server_functions.lua, et l’enregistrement des items utilisables en dessous |
| Un target différent | target/target.lua — les listes d’options sont partagées, seuls les deux appels addModel / AddTargetModel diffèrent |
| Libellés, icônes ou distance target | target/target.lua pour les icônes et la distance, locales/ pour les libellés |
| Règles des jobs | CheckJobAccess dans client/client_functions.lua |
Sur QBCore et QBox avec ox_inventory démarré, server_functions.lua enregistre également chaque item de chicha et de meuble via le hook d’utilisation propre à ox_inventory, servant de recours de secours pour les configurations où le bridge d’items de QBCore ne relaie pas l’utilisation.
Touches et commandes
Section intitulée « Touches et commandes »| Touche ou commande | Quand | Ce qu’elle fait |
|---|---|---|
| E | En tenant une chicha | Commence le placement |
| X | En tenant une chicha | Range sans placer |
| Molette de la souris | Pendant le placement | Fait pivoter l’aperçu |
| Flèche haut / bas | Pendant le placement | Monte ou descend l’aperçu |
| E | Pendant le placement | Pose l’objet |
| X | Pendant le placement | Annule |
| E | En tenant le tuyau d’une chicha allumée | Tire une bouffée |
| X (“Hookah - Stand Up X”) | En étant assis | Se relever. Modifiable dans les assignations de touches FiveM |
/hookah:chair:stand_up | En étant assis | Identique, sous forme de commande |