Documentazione di Pulse Phone

API per sviluppatori di Pulse Phone

Pulse Phone offre alle altre resource un'API server e client: leggere il numero di un giocatore, inviare SMS, mail e notifiche, effettuare chiamate, reagire a ciò che accade sul telefono e aggiungere app tue. Tutto ciò che è in questa pagina è preso dalla resource phone di Pulse Phone 1.5.0. L'elenco completo, con ogni argomento, è in Export ed eventi.

Per Pulse Phone 1.5.24 min di letturaAggiornato il

Dove si trova l'API

La resource si chiama phone, quindi ogni chiamata è exports.phone:.... Aspetta il telefono prima di usarlo: IsReady() diventa true quando il database risponde e il telefono accetta richieste.

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

phone_api nella console del server stampa un breve riepilogo dell'API delle app.

Gli export server più usati

Export Cosa fa
GetPhoneNumber(src) il numero del telefono che il giocatore possiede, o nil finché non è stato caricato
SourceOfNumber(number) il giocatore online con quel numero, o nil
Notify(src, { title, body, app?, actions? }) una notifica sul telefono di quel giocatore, con fino a 3 pulsanti
SendMessage(src, number, text) un SMS da quel giocatore a un numero
SendMail(address, sender, subject, body) una mail a un indirizzo
Call(src, number, video?) avvia una chiamata per quel giocatore
SetPhoneDisabled(src, bool) spegne o accende il telefono di un giocatore (una prigione, una cutscene)
RecordTransaction(number, 'sent' or 'received', amount, party, note?) una riga di estratto conto in Wallet; non sposta denaro

Gli script scritti per un altro telefono chiamano queste al posto degli export di quel telefono:

Export Cosa fa
ResolvePhone(target[, cb]) trova un telefono tramite { source }, { number }, { email }, { identifier } o { imei }
DeliverMailTo(target, mail[, cb]) mail a quel telefono: { sender, subject, body }
SendText(from, to, body[, opts][, cb]) un SMS da un telefono, o da un servizio con nome
DispatchAlert(jobs, { title, body, coords? }) un avviso a ogni membro in servizio di quei lavori; restituisce quanti ne ha raggiunti

Esempio: uno script di rapina avvisa la polizia con un segnaposto sulla mappa.

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),
})

Eventi server

Ascolta con AddEventHandler in uno script server. Solo il telefono li genera; un client non può falsificarli.

Evento Argomenti
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: è stato premuto un pulsante offerto dal tuo Notify

Export client

Export Cosa fa
Open(), Close(), IsOpen() apre o chiude il telefono; Open rispetta tutti i blocchi qui sotto
AddOpenCheck(fn) fn() che restituisce false impedisce l'apertura del telefono; viene rimosso quando la tua resource si ferma
SetRestriction(key, mode) uno stato del giocatore tuo: 'block', 'emergency-only' o nil per cancellarlo
SetCarAudio(state) mostra la tua autoradio su Pulse Drive, lo schermo dell'auto
GetPhoneNumber(), IsInCall(), GetBattery() il telefono di questo giocatore

Esempio: niente telefono mentre un giocatore è nella tua prigione.

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

State bag

Il server li scrive in Player(src).state, con i nomi usati dalle altre resource telefono, così gli script HUD e di dispatch li leggono invariati: phoneNumber, phoneOpen, inCall, onCallWith, phoneBattery, phoneDead. I client leggono i propri come LocalPlayer.state.phoneOpen.

Esempi di configurazione

Le impostazioni del telefono sono in phone/config/. Tre da cui dipendono altri script:

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
}

Le tue app

exports.phone:RegisterApp({ id, name, colour, icon, page = { kind = 'frame', url = 'ui/index.html' } }) aggiunge un'app alla schermata Home e all'App Hub. La pagina gira in un frame proprio e parla con il tuo server tramite il telefono. Permessi, notifiche, lingue e scheda nell'App Hub sono campi facoltativi. La guida completa è App personalizzate.

Note sull'integrazione

  • Pulse Phone risponde da solo ai nomi di evento di lb-phone, qb-phone e NPWD, quindi gli script che inviano mail, SMS e avvisi in quel modo continuano a funzionare. Gli script che chiamano gli export di un altro telefono richiedono una modifica: exports.phone. Vedi Cambiare telefono.
  • Passa il vero source dai tuoi eventi server. Non prendere mai un id giocatore da un messaggio del client.
  • Banca, garage, abitazioni e dispatch sono collegati tramite i bridge del telefono, scelti all'avvio. Il tuo script può essere aggiunto come provider: Integrazioni avanzate.

Domande frequenti

Come si chiama la resource di Pulse Phone?

phone. Ogni export è exports.phone:Name(...). Mantieni il nome della cartella, perché gli altri script e gli hook degli oggetti dell'inventario la chiamano con quel nome.

Gli script fatti per lb-phone o qb-phone funzionano con Pulse Phone?

Gli script che usano gli eventi di quei telefoni (mail, SMS, notifiche, numero di telefono) funzionano senza modifiche. Gli script che chiamano i loro export richiedono invece exports.phone.

Posso aggiungere una mia app a Pulse Phone?

Sì. Registrala con RegisterApp dalla tua resource. Compare nell'App Hub e la guida spiega pagine, permessi e notifiche.

Tradotto dall'inglese. Se qualcosa qui non corrisponde alla pagina in inglese, vale la pagina in inglese. English