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 |