Configuration

Le fichier config.lua centralise les réglages destinés au client. Les fichiers config.lua et locales/*.lua restent modifiables.

Configuration générale

Config.Framework

Définit le framework utilisé par zSleep.

• Type : string
• Valeur par défaut : "esx"
• Valeurs disponibles : "esx" ou "qbcore"

Framework = "esx"

Config.GetCoreObject

Retourne l'objet du framework utilisé par le serveur.

• Type : function
• Paramètres : aucun
• Valeur retournée : objet ESX ou QBCore
• Valeur par défaut : récupération du core es_extended

Configuration ESX fournie :

GetCoreObject = function()
    return exports["es_extended"]:getSharedObject()
end,

Exemple pour une installation QBCore standard :

Framework = "qbcore",
GetCoreObject = function()
    return exports["qb-core"]:GetCoreObject()
end,

Adaptez le nom de la ressource si votre core QBCore utilise un autre nom.

Config.Locale

Sélectionne la langue utilisée par les messages de zSleep.

• Type : string
• Valeur par défaut : "fr"
• Valeurs incluses : "fr" et "en"
• Valeurs personnalisées : toute clé ajoutée dans Locales

Locale = "fr"

Config.LogoutEvent

Définit le nom de l'événement serveur utilisé par une ressource externe pour signaler une déconnexion.

• Type : string
• Valeur par défaut : "zSleep:LogoutEvent"
• Valeur possible : un nom d'événement serveur unique

LogoutEvent = "zSleep:LogoutEvent"

Si vous changez ce nom, utilisez exactement la même valeur dans votre menu ou système de déconnexion.

Configuration du portage

Config.Carry.isEnabled

Active ou désactive l'ensemble du système de portage.

• Type : boolean
• Valeur par défaut : true
• Valeurs disponibles : true ou false

isEnabled = true

Lorsque la valeur est false, la commande de portage n'est pas enregistrée.

Config.Carry.commandName

Définit le nom de la commande, sans le caractère /.

• Type : string
• Valeur par défaut : "carry"
• Valeur possible : un nom de commande FiveM valide

commandName = "carry"

Avec cette valeur, les joueurs utilisent /carry.

Config.Carry.targetEvent

Permet à un système de cible ou d'interaction de transmettre directement un ped à porter.

• Type : string
• Valeur par défaut : ""
• Valeur possible : une chaîne vide ou un nom d'événement client

targetEvent = "mon_target:porterPed"

Laissez une chaîne vide si vous n'utilisez pas cette intégration.

Config.Carry.key

Déclare la valeur de touche prévue dans la configuration du portage.

• Type : string
• Valeur par défaut : "RCONTROL"
• Valeur possible : un nom de contrôle FiveM

key = "RCONTROL"

L'utilisation standard de cette version passe par la commande configurée dans Config.Carry.commandName.

Config.Carry.maxRadius

Définit la distance maximale dans laquelle zSleep recherche une personne à porter.

• Type : number
• Valeur par défaut : 5
• Valeur possible : une distance positive

maxRadius = 5

Animations

Les animations sont regroupées dans Config.Animations. Chaque entrée contient un dictionnaire GTA V et le nom de l'animation à jouer.

Sommeil au sol

["sleeping"] = {
    dictionnary = "timetable@tracy@sleep@",
    animation = "idle_c"
}

• Config.Animations["sleeping"].dictionnary — Valeur par défaut : "timetable@tracy@sleep@".
• Config.Animations["sleeping"].animation — Valeur par défaut : "idle_c".

Réveil

["gettingUp"] = {
    dictionnary = "get_up@sat_on_floor@to_stand",
    animation = "getup_0"
}

• Config.Animations["gettingUp"].dictionnary — Valeur par défaut : "get_up@sat_on_floor@to_stand".
• Config.Animations["gettingUp"].animation — Valeur par défaut : "getup_0".

Sommeil dans un véhicule

["sleepingInCar"] = {
    dictionnary = "random@car_sleeping",
    animation = "sleeping_idle"
}

• Config.Animations["sleepingInCar"].dictionnary — Valeur par défaut : "random@car_sleeping".
• Config.Animations["sleepingInCar"].animation — Valeur par défaut : "sleeping_idle".

Utilisez uniquement des dictionnaires et des noms d'animations GTA V valides.

Propriétés des personnages endormis

Les options de Config.Peds déterminent leur apparence et leur interaction avec le monde.

Config.Peds.alpha

Applique une opacité de 200 lorsqu'elle est activée.

• Type : boolean
• Valeur par défaut : true

Config.Peds.invincible

Rend les personnages endormis invincibles lorsqu'elle est activée.

• Type : boolean
• Valeur par défaut : true

Config.Peds.collision

Définit si les personnages endormis conservent leurs collisions.

• Type : boolean
• Valeur par défaut : false

Configuration complète par défaut :

Peds = {
    alpha = true,
    invincible = true,
    collision = false
}

Notifications

Config.SendNotification(message)

Affiche une notification au joueur, notamment lorsqu'aucune personne compatible n'est trouvée à proximité.

• Type : function
• Paramètre : message
• Type du paramètre : string
• Valeur retournée : aucune

Implémentation ESX fournie :

SendNotification = function(message)
    local ESX = exports["es_extended"]:getSharedObject()
    ESX.ShowNotification(message)
end

Exemple pour une installation QBCore standard :

SendNotification = function(message)
    local QBCore = exports["qb-core"]:GetCoreObject()
    QBCore.Functions.Notify(message)
end

Vous pouvez remplacer le contenu de cette fonction par l'appel client de votre système de notifications.