Documentation Pulse Phone

API développeur de Pulse Phone

Pulse Phone offre aux autres resources une API serveur et client : lire le numéro d'un joueur, envoyer des SMS, des mails et des notifications, passer des appels, réagir à ce qui se passe sur le téléphone, et ajouter vos propres apps. Tout ce qui figure sur cette page est tiré de la resource phone de Pulse Phone 1.5.0. La liste complète, avec chaque argument, se trouve sur Exports et événements.

Pour Pulse Phone 1.5.24 min de lectureMis à jour le

Où se trouve l'API

La resource s'appelle phone, donc chaque appel est exports.phone:.... Attendez le téléphone avant de l'utiliser : IsReady() renvoie true quand la base de données répond et que le téléphone accepte les requêtes.

Lua
CreateThread(function()
    while GetResourceState('phone') ~= 'started' or not exports.phone:IsReady() do Wait(500) end
    print('Pulse Phone is ready')
end)

phone_api dans la console du serveur affiche un court résumé de l'API des apps.

Exports serveur les plus utilisés

Export Ce qu'il fait
GetPhoneNumber(src) le numéro du téléphone que le joueur tient, ou nil tant qu'il n'est pas chargé
SourceOfNumber(number) le joueur en ligne avec ce numéro, ou nil
Notify(src, { title, body, app?, actions? }) une notification sur le téléphone de ce joueur, avec jusqu'à 3 boutons
SendMessage(src, number, text) un SMS de ce joueur vers un numéro
SendMail(address, sender, subject, body) un mail vers une adresse
Call(src, number, video?) passe un appel pour ce joueur
SetPhoneDisabled(src, bool) éteint ou allume le téléphone d'un joueur (prison, cinématique)
RecordTransaction(number, 'sent' or 'received', amount, party, note?) une ligne de relevé dans Wallet ; elle ne déplace pas d'argent

Les scripts écrits pour un autre téléphone appellent ceux-ci à la place des exports de ce téléphone :

Export Ce qu'il fait
ResolvePhone(target[, cb]) trouve un téléphone par { source }, { number }, { email }, { identifier } ou { imei }
DeliverMailTo(target, mail[, cb]) mail vers ce téléphone : { sender, subject, body }
SendText(from, to, body[, opts][, cb]) un SMS depuis un téléphone, ou depuis un service nommé
DispatchAlert(jobs, { title, body, coords? }) une alerte à chaque membre en service de ces jobs ; renvoie le nombre de personnes jointes

Exemple : un script de braquage alerte la police avec un repère sur la carte.

Lua
local reached = exports.phone:DispatchAlert({ 'police', 'sheriff' }, {
    title = 'Store robbery',
    body = 'Alarm at the 24/7 on Innocence Blvd.',
    coords = vector3(25.7, -1345.6, 29.5),
})

Événements serveur

Écoutez avec AddEventHandler dans un script serveur. Seul le téléphone les déclenche ; un client ne peut pas les simuler.

Événement Arguments
phone:numberChanged src, number, oldNumber
phone:callStarted callId, fromNumber, toNumber, fromSrc, toSrc, video
phone:callEnded fromNumber, toNumber, reason, durationMs, fromSrc, toSrc, callId
phone:messageSent fromNumber, toNumber, body
phone:emergencyCall src, service, reason, coords
phone:wallet:transfer fromNumber, toNumber, amount, note
phone:notification:action src, app, notificationId, actionId : un bouton proposé par votre Notify a été pressé

Exports client

Export Ce qu'il fait
Open(), Close(), IsOpen() ouvre ou ferme le téléphone ; Open respecte tous les blocages ci-dessous
AddOpenCheck(fn) fn() qui renvoie false empêche l'ouverture du téléphone ; retiré quand votre resource s'arrête
SetRestriction(key, mode) un état de joueur à vous : 'block', 'emergency-only' ou nil pour l'effacer
SetCarAudio(state) affiche votre autoradio sur Pulse Drive, l'écran de la voiture
GetPhoneNumber(), IsInCall(), GetBattery() le propre téléphone de ce joueur

Exemple : pas de téléphone pendant qu'un joueur est dans votre prison.

Lua
exports.phone:SetRestriction('myjail', 'block')   -- on entering the cell
exports.phone:SetRestriction('myjail', nil)       -- on release

Sacs d'état (state bags)

Le serveur les écrit dans Player(src).state, avec les noms que d'autres resources de téléphone utilisent, pour que les scripts de HUD et de dispatch les lisent sans changement : phoneNumber, phoneOpen, inCall, onCallWith, phoneBattery, phoneDead. Les clients lisent les leurs avec LocalPlayer.state.phoneOpen.

Exemples de config

Les réglages du téléphone se trouvent dans phone/config/. Trois dont dépendent d'autres scripts :

Lua
Config.Item = {
    required = false,    -- true: the player needs the phone item
    name     = 'phone',
}
Config.Public = {
    numberState = true,  -- publish Player(src).state.phoneNumber
}
Config.Open = {
    blockWhenNuiFocused = true,   -- no phone while another menu holds the cursor
}

Vos propres apps

exports.phone:RegisterApp({ id, name, colour, icon, page = { kind = 'frame', url = 'ui/index.html' } }) ajoute une app à l'écran d'accueil et à l'App Hub. La page s'exécute dans son propre frame et parle à votre serveur via le téléphone. Les permissions, les notifications, les langues et la fiche dans l'App Hub sont des champs facultatifs. Le guide complet est Apps personnalisées.

Notes d'intégration

  • Pulse Phone répond lui-même aux noms d'événements de lb-phone, qb-phone et NPWD, donc les scripts qui envoient des mails, des SMS et des alertes de cette façon continuent de fonctionner. Les scripts qui appellent les exports d'un autre téléphone ont besoin d'un seul changement : exports.phone. Voir Changer de téléphone.
  • Transmettez le vrai source depuis vos propres événements serveur. Ne prenez jamais un identifiant de joueur dans un message du client.
  • La banque, les garages, l'immobilier et le dispatch sont reliés via les passerelles du téléphone, choisies au démarrage. Votre propre script peut être ajouté comme fournisseur : Intégrations avancées.

Questions fréquentes

Comment s'appelle la resource de Pulse Phone ?

phone. Chaque export est exports.phone:Name(...). Gardez le nom du dossier, car d'autres scripts et les hooks d'items de l'inventaire l'appellent par ce nom.

Les scripts faits pour lb-phone ou qb-phone fonctionnent-ils avec Pulse Phone ?

Les scripts qui utilisent les événements de ces téléphones (mail, SMS, notifications, numéro de téléphone) fonctionnent sans modification. Les scripts qui appellent leurs exports ont besoin de exports.phone à la place.

Puis-je ajouter ma propre app à Pulse Phone ?

Oui. Enregistrez-la avec RegisterApp depuis votre resource. Elle apparaît dans l'App Hub, et le guide couvre les pages, les permissions et les notifications.

Traduit de l'anglais. En cas de désaccord entre cette page et la page en anglais, c'est la page en anglais qui fait foi. English