Dokumentacija Pulse Phone
API za razvijalce Pulse Phone
Pulse Phone daje drugim resourcom API za strežnik in odjemalca: preberite številko igralca, pošiljajte sporočila, pošto in obvestila, vzpostavljajte klice, odzivajte se na dogajanje v telefonu in dodajajte lastne aplikacije. Vse na tej strani je vzeto iz resourca telefona Pulse Phone 1.5.0. Celoten seznam z vsemi argumenti je na strani Exporti in eventi.
Kje je API
Resource se imenuje phone, zato je vsak klic exports.phone:.... Pred uporabo počakajte na telefon:
IsReady() postane true, ko baza odgovori in telefon sprejema zahteve.
CreateThread(function()
while GetResourceState('phone') ~= 'started' or not exports.phone:IsReady() do Wait(500) end
print('Pulse Phone is ready')
end)phone_api v konzoli strežnika izpiše kratek povzetek API-ja za aplikacije.
Najpogosteje uporabljeni exporti strežnika
| Export | Kaj naredi |
|---|---|
GetPhoneNumber(src) |
številka telefona, ki ga igralec drži, ali nil, dokler se ne naloži |
SourceOfNumber(number) |
igralec na spletu s to številko ali nil |
Notify(src, { title, body, app?, actions? }) |
obvestilo na igralčevem telefonu z do 3 gumbi |
SendMessage(src, number, text) |
sporočilo od tega igralca na številko |
SendMail(address, sender, subject, body) |
pošta na naslov |
Call(src, number, video?) |
vzpostavi klic za tega igralca |
SetPhoneDisabled(src, bool) |
izklopi ali vklopi igralčev telefon (zapor, cutscena) |
RecordTransaction(number, 'sent' or 'received', amount, party, note?) |
izpisna vrstica v Wallet; denarja ne premika |
Skripti, napisani za drug telefon, kličejo te namesto exportov tistega telefona:
| Export | Kaj naredi |
|---|---|
ResolvePhone(target[, cb]) |
najde telefon po { source }, { number }, { email }, { identifier } ali { imei } |
DeliverMailTo(target, mail[, cb]) |
pošta na ta telefon: { sender, subject, body } |
SendText(from, to, body[, opts][, cb]) |
sporočilo od telefona ali od poimenovane storitve |
DispatchAlert(jobs, { title, body, coords? }) |
opozorilo vsem članom teh služb, ki so na dolžnosti; vrne, koliko jih je doseglo |
Primer: skript ropa opozori policijo z oznako na zemljevidu.
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 strežnika
Poslušajte z AddEventHandler v skriptu strežnika. Dvigne jih samo telefon; odjemalec jih ne more ponarediti.
| Event | 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: pritisnjen je bil gumb, ki ga je ponudil klic Notify |
Exporti odjemalca
| Export | Kaj naredi |
|---|---|
Open(), Close(), IsOpen() |
odpre ali zapre telefon; Open upošteva vse spodnje blokade |
AddOpenCheck(fn) |
fn() vrne false, kar prepreči odprtje telefona; odstrani se, ko se vaš resource ustavi |
SetRestriction(key, mode) |
vaše lastno stanje igralca: 'block', 'emergency-only' ali nil za brisanje |
SetCarAudio(state) |
prikaže vaš avtoradio v Pulse Drive, zaslonu v avtomobilu |
GetPhoneNumber(), IsInCall(), GetBattery() |
igralčev lastni telefon |
Primer: igralec med zaporom v vašem skriptu nima telefona.
exports.phone:SetRestriction('myjail', 'block') -- on entering the cell
exports.phone:SetRestriction('myjail', nil) -- on releaseState bagi
Strežnik jih zapisuje v Player(src).state z imeni, ki jih uporabljajo drugi telefonski resourci, zato jih skripti za HUD in dispečerstvo berejo nespremenjene: phoneNumber, phoneOpen, inCall, onCallWith, phoneBattery,
phoneDead. Odjemalci svoje berejo kot LocalPlayer.state.phoneOpen.
Primeri konfiguracije
Nastavitve telefona so v phone/config/. Tri, od katerih so odvisni drugi skripti:
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 lastne aplikacije
exports.phone:RegisterApp({ id, name, colour, icon, page = { kind = 'frame', url = 'ui/index.html' } })
doda aplikacijo na začetni zaslon in v App Hub. Stran teče v svojem okvirju in se prek telefona pogovarja z vašim strežnikom. Dovoljenja, obvestila, jeziki in vnos v App Hub so neobvezna polja. Celoten vodnik je Aplikacije po meri.
Opombe o integraciji
- Pulse Phone sam odgovarja na imena eventov lb-phone, qb-phone in NPWD, zato skripti, ki tako pošiljajo pošto, sporočila in opozorila, delujejo naprej. Skripti, ki kličejo exporte drugega telefona, potrebujejo eno spremembo:
exports.phone. Glejte Menjava telefona. - Podajte pravi
sourceiz svojih eventov strežnika. Nikoli ne vzemite ID-ja igralca iz sporočila odjemalca. - Bančništvo, garaže, nepremičnine in dispečerstvo so povezani prek mostov telefona, izbranih ob zagonu. Vaš skript lahko dodate kot ponudnika: Napredne integracije.
Pogosta vprašanja
Kako se imenuje resource Pulse Phone?
phone. Vsak export je exports.phone:Name(...). Ime mape pustite, ker ga kličejo drugi skripti in hooki predmetov inventarja.
Ali skripti za lb-phone ali qb-phone delujejo s Pulse Phone?
Skripti, ki uporabljajo evente teh telefonov (pošta, sporočila, obvestila, telefonska številka), delujejo brez popravkov. Skripti, ki kličejo njihove exporte, potrebujejo exports.phone namesto tega.
Ali lahko v Pulse Phone dodam svojo aplikacijo?
Da. Registrirajte jo z RegisterApp iz svojega resourca. Prikaže se v App Hub, vodnik pa pokriva strani, dovoljenja in obvestila.