Pulse Phone dokumentacija
Developer API za Pulse Phone
Pulse Phone daje drugim resursima server i klijentski API: čitanje broja igrača, slanje SMS poruka, maila i obavijesti, upućivanje poziva, reagovanje na ono što se događa na telefonu i dodavanje vlastitih aplikacija. Sve na ovoj stranici preuzeto je iz resursa phone u Pulse Phone 1.5.0. Cijeli spisak, sa svim argumentima, nalazi se na stranici Exporti i događaji.
Gdje se nalazi API
Resurs se zove phone, pa je svaki poziv exports.phone:.... Prije korištenja sačekajte telefon: IsReady() postaje true kad baza podataka odgovori i telefon prima zahtjeve.
CreateThread(function()
while GetResourceState('phone') ~= 'started' or not exports.phone:IsReady() do Wait(500) end
print('Pulse Phone is ready')
end)phone_api u konzoli servera ispisuje kratak sažetak API-ja za aplikacije.
Najčešće korišteni server exporti
| Export | Šta radi |
|---|---|
GetPhoneNumber(src) |
broj telefona koji igrač drži, ili nil dok se ne učita |
SourceOfNumber(number) |
igrač na mreži s tim brojem, ili nil |
Notify(src, { title, body, app?, actions? }) |
obavijest na telefonu tog igrača, s do 3 dugmeta |
SendMessage(src, number, text) |
SMS poruka od tog igrača na neki broj |
SendMail(address, sender, subject, body) |
mail na adresu |
Call(src, number, video?) |
upućuje poziv za tog igrača |
SetPhoneDisabled(src, bool) |
isključuje ili uključuje igračev telefon (zatvor, cutscena) |
RecordTransaction(number, 'sent' or 'received', amount, party, note?) |
stavka izvoda u Novčaniku; ne pomjera novac |
Skripte pisane za drugi telefon pozivaju ove umjesto exporta tog telefona:
| Export | Šta radi |
|---|---|
ResolvePhone(target[, cb]) |
pronalazi telefon po { source }, { number }, { email }, { identifier } ili { imei } |
DeliverMailTo(target, mail[, cb]) |
mail na taj telefon: { sender, subject, body } |
SendText(from, to, body[, opts][, cb]) |
SMS poruka s telefona ili od imenovane službe |
DispatchAlert(jobs, { title, body, coords? }) |
upozorenje svakom članu tih poslova koji je na dužnosti; vraća koliko ih je primilo |
Primjer: skripta pljačke upozorava policiju oznakom na mapi.
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),
})Server događaji
Slušajte ih preko AddEventHandler u server skripti. Pokreće ih samo telefon; klijent ih ne može lažirati.
| Događaj | Argumenti |
|---|---|
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: pritisnuto je dugme koje je ponudio vaš Notify |
Klijentski exporti
| Export | Šta radi |
|---|---|
Open(), Close(), IsOpen() |
otvara ili zatvara telefon; Open poštuje sve blokade u nastavku |
AddOpenCheck(fn) |
fn() koji vraća false sprečava otvaranje telefona; uklanja se kad se vaš resurs zaustavi |
SetRestriction(key, mode) |
vlastito stanje igrača: 'block', 'emergency-only' ili nil za brisanje |
SetCarAudio(state) |
prikazuje vaš auto radio u Pulse Driveu, ekranu automobila |
GetPhoneNumber(), IsInCall(), GetBattery() |
vlastiti telefon ovog igrača |
Primjer: nema telefona dok je igrač u vašem zatvoru.
exports.phone:SetRestriction('myjail', 'block') -- on entering the cell
exports.phone:SetRestriction('myjail', nil) -- on releaseStanja igrača (state bags)
Server ih upisuje u Player(src).state, pod nazivima koje koriste drugi resursi telefona, pa ih HUD i dispatch skripte čitaju bez izmjena: phoneNumber, phoneOpen, inCall, onCallWith, phoneBattery, phoneDead. Klijenti svoje čitaju kao LocalPlayer.state.phoneOpen.
Primjeri konfiguracije
Postavke telefona nalaze se u phone/config/. Tri od kojih zavise druge skripte:
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
}Vaše vlastite aplikacije
exports.phone:RegisterApp({ id, name, colour, icon, page = { kind = 'frame', url = 'ui/index.html' } }) dodaje aplikaciju na početni ekran i u App Hub. Stranica radi u vlastitom frameu i s vašim serverom komunicira preko telefona. Dozvole, obavijesti, jezici i unos u App Hubu su opcionalna polja. Cijeli vodič je Custom aplikacije.
Napomene o integraciji
- Pulse Phone sam odgovara na nazive događaja iz lb-phone, qb-phone i NPWD, pa skripte koje na taj način šalju mail, SMS poruke i upozorenja nastavljaju raditi. Skripte koje pozivaju exporte drugog telefona trebaju jednu izmjenu:
exports.phone. Pogledajte Zamjena telefona. - Prosljeđujte pravi
sourceiz vlastitih server događaja. Nikad ne uzimajte id igrača iz klijentske poruke. - Banke, garaže, stanovanje i dispatch povezuju se preko mostova telefona, koji se biraju pri pokretanju. Vaša vlastita skripta može se dodati kao provider: Napredne integracije.
Česta pitanja
Kako se zove resurs Pulse Phone?
phone. Svaki export je exports.phone:Name(...). Zadržite naziv foldera, jer ga druge skripte i hookovi predmeta inventara pozivaju tim imenom.
Rade li skripte napravljene za lb-phone ili qb-phone s Pulse Phone?
Skripte koje koriste događaje tih telefona (mail, SMS poruke, obavijesti, broj telefona) rade bez izmjena. Skripte koje pozivaju njihove exporte umjesto toga trebaju exports.phone.
Mogu li dodati vlastitu aplikaciju u Pulse Phone?
Da. Registrujte je preko RegisterApp iz svog resursa. Pojavljuje se u App Hubu, a vodič pokriva stranice, dozvole i obavijesti.