Documentația Pulse Phone
API pentru dezvoltatori Pulse Phone
Pulse Phone oferă altor resurse un API de server și de client: citești numărul unui jucător, trimiți mesaje, mail-uri și notificări, inițiezi apeluri, reacționezi la ce se întâmplă pe telefon și adaugi aplicații proprii. Tot ce este pe această pagină provine din resursa phone din Pulse Phone 1.5.0. Lista completă, cu fiecare argument, este la Exporturi și evenimente.
Unde se află API-ul
Resursa se numește phone, deci fiecare apel este exports.phone:.... Așteaptă telefonul înainte să-l folosești:
IsReady() devine true după ce baza de date răspunde și telefonul acceptă cereri.
CreateThread(function()
while GetResourceState('phone') ~= 'started' or not exports.phone:IsReady() do Wait(500) end
print('Pulse Phone is ready')
end)phone_api în consola serverului afișează un scurt rezumat al API-ului pentru aplicații.
Cele mai folosite exporturi de server
| Export | Ce face |
|---|---|
GetPhoneNumber(src) |
numărul telefonului pe care îl deține jucătorul sau nil până se încarcă |
SourceOfNumber(number) |
jucătorul online cu acel număr sau nil |
Notify(src, { title, body, app?, actions? }) |
o notificare pe telefonul acelui jucător, cu până la 3 butoane |
SendMessage(src, number, text) |
un mesaj de la acel jucător către un număr |
SendMail(address, sender, subject, body) |
un mail către o adresă |
Call(src, number, video?) |
inițiază un apel pentru acel jucător |
SetPhoneDisabled(src, bool) |
oprește sau pornește telefonul unui jucător (închisoare, cutscene) |
RecordTransaction(number, 'sent' or 'received', amount, party, note?) |
o linie de extras în Wallet; nu mută bani |
Scripturile scrise pentru alt telefon apelează acestea în loc de exporturile acelui telefon:
| Export | Ce face |
|---|---|
ResolvePhone(target[, cb]) |
găsește un telefon după { source }, { number }, { email }, { identifier } sau { imei } |
DeliverMailTo(target, mail[, cb]) |
mail către acel telefon: { sender, subject, body } |
SendText(from, to, body[, opts][, cb]) |
un mesaj de la un telefon sau de la un serviciu cu nume |
DispatchAlert(jobs, { title, body, coords? }) |
o alertă către fiecare membru aflat în tură din acele joburi; returnează câți a atins |
Exemplu: un script de jaf alertează poliția cu un pin pe hartă.
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),
})Evenimente de server
Ascultă cu AddEventHandler într-un script de server. Doar telefonul le declanșează; un client nu le poate falsifica.
| Eveniment | Argumente |
|---|---|
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: a fost apăsat un buton oferit de apelul tău Notify |
Exporturi de client
| Export | Ce face |
|---|---|
Open(), Close(), IsOpen() |
deschide sau închide telefonul; Open respectă fiecare blocare de mai jos |
AddOpenCheck(fn) |
fn() returnează false și oprește deschiderea telefonului; este eliminat când resursa ta se oprește |
SetRestriction(key, mode) |
o stare proprie a jucătorului: 'block', 'emergency-only' sau nil pentru a o șterge |
SetCarAudio(state) |
arată player-ul tău auto în Pulse Drive, ecranul mașinii |
GetPhoneNumber(), IsInCall(), GetBattery() |
telefonul propriu al acestui jucător |
Exemplu: niciun telefon cât timp un jucător este în închisoarea ta.
exports.phone:SetRestriction('myjail', 'block') -- on entering the cell
exports.phone:SetRestriction('myjail', nil) -- on releaseState bag-uri
Serverul le scrie în Player(src).state, cu numele folosite de alte resurse de telefon, astfel încât scripturile de HUD și dispecerat să le citească neschimbate: phoneNumber, phoneOpen, inCall, onCallWith, phoneBattery,
phoneDead. Clienții le citesc pe ale lor ca LocalPlayer.state.phoneOpen.
Exemple de configurare
Setările telefonului sunt în phone/config/. Trei de care depind alte scripturi:
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
}Propriile aplicații
exports.phone:RegisterApp({ id, name, colour, icon, page = { kind = 'frame', url = 'ui/index.html' } })
adaugă o aplicație pe ecranul principal și în App Hub. Pagina rulează în propriul cadru și vorbește cu serverul tău prin telefon. Permisiunile, notificările, limbile și intrarea din App Hub sunt câmpuri opționale. Ghidul complet este Aplicații custom.
Note de integrare
- Pulse Phone răspunde singur la numele evenimentelor din lb-phone, qb-phone și NPWD, așa că scripturile care trimit mail-uri, mesaje și alerte astfel continuă să funcționeze. Scripturile care apelează exporturile altui telefon au nevoie de o singură schimbare:
exports.phone. Vezi Schimbarea telefonului. - Transmite adevăratul
sourcedin propriile evenimente de server. Nu lua niciodată un id de jucător dintr-un mesaj de client. - Banking-ul, garajele, locuințele și dispeceratul sunt conectate prin punțile telefonului, alese la pornire. Propriul tău script poate fi adăugat ca furnizor: Integrări avansate.
Întrebări frecvente
Cum se numește resursa Pulse Phone?
phone. Fiecare export este exports.phone:Name(...). Păstrează numele folderului, pentru că alte scripturi și hook-urile itemelor din inventar îl apelează după acest nume.
Funcționează cu Pulse Phone scripturile făcute pentru lb-phone sau qb-phone?
Scripturile care folosesc evenimentele acestor telefoane (mail, mesaje, notificări, număr de telefon) funcționează fără editări. Scripturile care le apelează exporturile au nevoie în schimb de exports.phone.
Pot adăuga propria aplicație în Pulse Phone?
Da. Înregistreaz-o cu RegisterApp din resursa ta. Apare în App Hub, iar ghidul acoperă paginile, permisiunile și notificările.