Fenêtres et menus

Trois types de fenêtre : saisie (input), confirmation (confirm) et choix (choice). Une seule fenêtre est ouverte à la fois ; en ouvrir une autre remplace la première.

Pendant qu’une fenêtre est ouverte, le joueur a le curseur et ne contrôle plus son personnage. Échap ferme la fenêtre, Entrée valide la saisie, Tab passe d’un bouton à l’autre.

Fenêtres bloquantes

La façon la plus simple : la fonction attend la réponse du joueur et la renvoie. Appelez-la dans un thread.

CreateThread(function()
    local plate = exports.mrpoulpi_ui:Input({ title = 'Plaque', placeholder = '12ABC345', maxLength = 8 })
    if not plate then return end

    if not exports.mrpoulpi_ui:Confirm(('Enregistrer la plaque %s ?'):format(plate)) then return end

    local method = exports.mrpoulpi_ui:Choice({
        title = 'Paiement',
        options = {
            { id = 'bank', label = 'Banque', variant = 'success' },
            { id = 'cash', label = 'Liquide', variant = 'info' }
        }
    })

    if method then
        TriggerServerEvent('garage:buyPlate', plate, method)
    end
end)

Si la fenêtre est fermée par un autre script ou remplacée par une autre, la fonction renvoie la valeur d’annulation.

Champs d’une fenêtre

Ces champs servent aussi bien aux fonctions bloquantes qu’à OpenUI.

Communs

Tous les textes acceptent une clé de shared/locales.lua à la place du texte.

Saisie (input)

Confirmation (confirm)

Choix (choice)

Chaque option :

Menus en sections

Dès qu’une option a un group, la fenêtre devient un menu : les options sont rangées sous un titre par groupe, dans l’ordre où les groupes apparaissent, et le bouton de fermeture passe en bas.

exports.mrpoulpi_ui:OpenUI({
    type = 'choice',
    title = 'Garage',
    columns = 2,
    options = {
        { id = 'out', group = 'Véhicules', label = 'Sortir', variant = 'success', action = 'garage:out' },
        { id = 'store', group = 'Véhicules', label = 'Ranger', action = 'garage:store' },
        { id = 'repair', group = 'Services', label = 'Réparer', variant = 'warning', action = 'garage:repair' },
        { id = 'wash', group = 'Services', label = 'Laver', disabled = true }
    }
})

Avec keepOpen = true, le joueur peut cliquer plusieurs boutons à la suite. Choice ne rend la main qu’au clic sur une option sans keepOpen, ou à la fermeture.

Actions

Plutôt que d’attendre la réponse, vous pouvez associer une action à un bouton. C’est utile pour un menu ouvert depuis le serveur, ou réutilisé à plusieurs endroits.

Au clic, dans cet ordre :

1. onSelect de l’option, s’il existe ;
2. le hook client Hooks.OnAction(name, payload, context) ;
3. l’action client enregistrée sous ce nom, si elle existe ;
4. sinon, si l’option a server = true, l’action est envoyée au serveur.

Le payload vaut { id = '…' } pour un choix et { value = … } pour une saisie ou une confirmation. context est la fenêtre entière.

Action client

exports.mrpoulpi_ui:RegisterUIAction('garage:out', function(payload, context)
    print('Option choisie :', payload.id)
end)

L’action est supprimée automatiquement quand la ressource qui l’a enregistrée s’arrête.

Action serveur

exports.mrpoulpi_ui:RegisterServerAction('shop:payBank', function(source, payload)
    -- payload.id ou payload.value, déjà vérifiés
end)

RegisterNetEvent('shop:open', function()
    exports.mrpoulpi_ui:OpenUI(source, {
        type = 'choice',
        title = 'Paiement',
        options = {
            { id = 'bank', label = 'Banque', variant = 'success', action = 'shop:payBank', server = true },
            { id = 'cash', label = 'Liquide', variant = 'info', action = 'shop:payCash', server = true }
        }
    })
end)

Le serveur accepte une action seulement dans deux cas :

Pour une fenêtre destinée à tous les joueurs, utilisez donc RegisterServerAction.

Avant d’arriver dans votre callback, chaque action est aussi :

• limitée à une toutes les Config.Security.actionCooldown millisecondes par joueur ;
• refusée si son nom dépasse 64 caractères ;
• nettoyée : seuls id (64 caractères au plus) et value (texte de Config.Input.maxLength caractères au plus, nombre ou booléen) sont transmis ;
• soumise à Hooks.CanUseAction(source, name, payload).

Les refus sont passés à Hooks.Log (unknown_action, action_denied, invalid_payload).

Modifier une fenêtre ouverte

exports.mrpoulpi_ui:SetUIData({ title = 'Garage (3 véhicules)' })

Les champs donnés remplacent les anciens ; les autres sont gardés. Pour suivre l’ouverture et la fermeture depuis un autre script, écoutez les events locaux mrpoulpi_ui:opened et mrpoulpi_ui:closed.

Bloquer l’ouverture

Dans client/hooks.lua, Hooks.CanOpen peut refuser une fenêtre selon l’état du joueur :

function Hooks.CanOpen(data)
    if IsEntityDead(PlayerPedId()) then
        return false
    end
    return true
end

Les fonctions bloquantes renvoient alors directement la valeur d’annulation.