Accueil › Documentation › Personnalisation · origen_dealerships

Personnalisation · origen_dealerships

Le dossier custom/ contient tous les points d’intégration entre origen_dealerships et le reste de ton serveur. Ces fichiers ne sont pas protégés par l’escrow et doivent être adaptés à ta configuration.

custom/
├── client/
│   ├── framework.lua   — player identifier, vehicle props, NPC interaction
│   ├── keys.lua        — vehicle key assignment on purchase
│   └── notify.lua      — notifications and text UI
└── server/
    ├── framework.lua   — admin check, payments, vehicle DB insertion
    ├── financing.lua   — financing eligibility hook
    └── plate.lua       — plate generation and uniqueness check

custom/client/framework.lua

Custom.GetPlayerIdentifier() → string

Renvoie l’identifiant unique du joueur local (citizenid ou identifier selon le framework).

Custom.GetPlayerIdentifier = function()
    local identifier = nil
    if Config.Framework == 'qb-core' then
        identifier = Framework.Functions.GetPlayerData().citizenid
    elseif Config.Framework == 'esx' then
        identifier = Framework.GetPlayerData().identifier
    end
    return identifier
end

Custom.HandleInteraction(interactionData) → boolean

Hook appelé quand un joueur tente d’interagir avec le PNJ d’une concession. Renvoie true pour remplacer le déroulement d’interaction par défaut, ou false pour laisser la ressource le gérer normalement.

Custom.HandleInteraction = function(interactionData)
    if interactionData.type == 'npc' then
        -- interactionData.onInteract() -- uncomment to delegate back
        return true -- return true to fully take over
    end
    return false
end

Custom.GetVehicleProps(vehicle) → table

Renvoie les propriétés de l’entité véhicule donnée. Utilise lib.getVehicleProperties quand Config.VehiclePurchase.useOxLibProps vaut true.

Custom.GetVehicleProps = function(vehicle)
    if Config.VehiclePurchase.useOxLibProps and lib and lib.getVehicleProperties then
        return lib.getVehicleProperties(vehicle)
    end
    -- fallback: returns basic props table
end

Custom.SetVehicleProps(vehicle, props) → boolean

Applique une table de propriétés à une entité véhicule. Utilise lib.setVehicleProperties quand il est disponible.

custom/client/keys.lua

Custom.GiveKeys(vehicle, plate) → boolean

Donne au joueur local les clés de propriétaire du véhicule indiqué. Appelée automatiquement après l’achat quand Config.VehiclePurchase.giveKeysOnPurchase vaut true.

Custom.GiveKeys = function(vehicle, plate)
    local plateToUse = plate or (DoesEntityExist(vehicle) and GetVehicleNumberPlateText(vehicle) or nil)
    TriggerEvent("vehiclekeys:client:SetOwner", plateToUse)
    return true
end

custom/client/notify.lua

Custom.Notify(text, type, length)

Affiche une notification au joueur local via lib.notify.

Custom.Notify = function(text, type, length)
    lib.notify({
        title       = 'Origen Dealerships',
        description = text,
        type        = type,
        duration    = length
    })
end

Custom.DrawText(text, key)

Affiche le text UI d’ox_lib avec une indication de touche.

Custom.HideText()

Masque le text UI d’ox_lib actif.

custom/server/framework.lua

Custom.isAdmin(source) → boolean

Vérifie si le joueur indiqué a des permissions d’administrateur selon Config.AdminGroups.

Custom.getPlayerIdentifier(source) → string | nil

Renvoie l’identifiant unique du joueur (citizenid pour QB/QBX, identifier pour ESX).

Custom.doPayment(source, paymentData) → boolean

Traite un paiement depuis le compte d’un joueur. Prend en charge les méthodes cash, bank et xp.

Custom.doPayment = function(source, paymentData)
    -- Handles cash/bank via framework, XP via exports['origen_xp']
end

Custom.removeFinanceMoney(source, amount) → boolean

Débite du compte bancaire du joueur le paiement d’une mensualité de financement.

Custom.addVehicleToDatabase(source, vehicleModel, plate, props, callback)

Insère un véhicule acheté dans la table de véhicules correspondant au framework actif.

Tables cibles :

Custom.GetPlayerSourceByIdentifier(identifier) → number | nil

Retrouve l’ID serveur (source) d’un joueur connecté à partir de son identifiant unique. Utilisée pour les notifications de paiements de financement.

Custom.canBuyCategory(source, categoryKey, vehicleModel) → { cant: boolean, msg: string }

Hook pour ajouter des restrictions personnalisées à l’achat de catégories de véhicules. Renvoie cant = false avec un message pour bloquer l’achat.

Custom.canBuyCategory = function(source, categoryKey, vehicleModel)
    -- Example: block category for players without a license
    return { cant = true, msg = "" }
end

custom/server/financing.lua

Custom.canFinanceVehicle(source, model, price, period) → { success: boolean, message: string }

Hook appelé avant la création d’un contrat de financement. Renvoie success = false avec un message pour bloquer l’opération.

Custom.canFinanceVehicle = function(source, model, price, period)
    return { success = true, message = '' }
end

custom/server/plate.lua

Custom.GeneratePlate() → string | nil

Génère une plaque d’immatriculation unique de 8 caractères (4 lettres + 4 chiffres). Réessaie jusqu’à 100 fois pour éviter les collisions. Renvoie nil si aucune plaque unique n’est trouvée après le nombre maximal de tentatives.

Custom.PlateExists(plate) → boolean

Vérifie si une plaque est déjà enregistrée dans la table des véhicules.