Exports

Tous les exports publics de zSleep V2 sont enregistrés côté serveur dans server/api.lua.

Exports client

zSleep V2 ne fournit actuellement aucun export client public.

Exports serveur

IsPlayerSleeping

Indique si un dormeur existe pour l'identifiant transmis.

Côté : Serveur Paramètre : identifier (string) Valeur retournée : boolean

Utilisation

local sleeping = exports["zSleep-v2"]:IsPlayerSleeping(identifier)

if sleeping then
    print("Ce joueur possède un dormeur.")
end

GetSleeper

Récupère une copie des données du dormeur associé à un identifiant.

Côté : Serveur Paramètre : identifier (string) Valeur retournée : table si le dormeur existe, sinon nil

Utilisation

local sleeper = exports["zSleep-v2"]:GetSleeper(identifier)

if sleeper then
    print(("Net ID du dormeur : %s"):format(sleeper.netId))
end

GetSleeperByNetId

Recherche un dormeur à partir de son Net ID.

Côté : Serveur Paramètre : netId (number) Première valeur retournée : identifier (string) ou nil Deuxième valeur retournée : copie du dormeur (table) ou nil

Utilisation

local identifier, sleeper = exports["zSleep-v2"]:GetSleeperByNetId(netId)

if identifier and sleeper then
    print(("Dormeur trouvé : %s"):format(identifier))
end

GetAllSleepers

Retourne une copie de tous les dormeurs, indexée par identifiant.

Côté : Serveur Paramètres : Aucun Valeur retournée : table<string, table>

Utilisation

local sleepers = exports["zSleep-v2"]:GetAllSleepers()

for identifier, sleeper in pairs(sleepers) do
    print(identifier, sleeper.netId)
end

RemoveSleeper

Supprime le dormeur associé à un identifiant du monde, de la mémoire et de la base de données.

Côté : Serveur Paramètres :

• identifier (string) — Identifiant du dormeur à supprimer.
• reason (string, facultatif) — Motif enregistré avec l'action. Sa valeur par défaut est "api".
• actor (table ou autre valeur, facultatif) — Informations sur l'auteur destinées au journal.

Valeurs retournées : success (boolean), puis reason lorsqu'une suppression échoue.

Utilisation

local actor = {
    source = source,
    name = GetPlayerName(source)
}

local success, reason = exports["zSleep-v2"]:RemoveSleeper(
    identifier,
    "Suppression administrative",
    actor
)

if not success then
    print(("Suppression refusée : %s"):format(reason))
end