Pulse Phone-dokumentasjon
Pulse Phone utvikler-API
Pulse Phone gir andre resources et server- og client-API: les en spillers nummer, send tekstmeldinger, e-post og varsler, ring opp, reager på det som skjer på telefonen, og legg til dine egne apper. Alt på denne siden er hentet fra phone-resourcen i Pulse Phone 1.5.0. Den komplette listen, med alle argumenter, står på Exports og events.
Hvor API-et ligger
Resourcen heter phone, så hvert kall er exports.phone:.... Vent på telefonen før du bruker den: IsReady() blir true når databasen svarer og telefonen tar imot forespørsler.
CreateThread(function()
while GetResourceState('phone') ~= 'started' or not exports.phone:IsReady() do Wait(500) end
print('Pulse Phone is ready')
end)phone_api i serverkonsollen skriver ut en kort oppsummering av app-API-et.
Mest brukte server-exports
| Export | Hva den gjør |
|---|---|
GetPhoneNumber(src) |
nummeret til telefonen spilleren har, eller nil til spilleren er lastet inn |
SourceOfNumber(number) |
spilleren som er pålogget med det nummeret, eller nil |
Notify(src, { title, body, app?, actions? }) |
et varsel på den spillerens telefon, med opptil 3 knapper |
SendMessage(src, number, text) |
en tekstmelding fra den spilleren til et nummer |
SendMail(address, sender, subject, body) |
en e-post til en adresse |
Call(src, number, video?) |
starter et anrop for den spilleren |
SetPhoneDisabled(src, bool) |
slår en spillers telefon av eller på (et fengsel, en cutscene) |
RecordTransaction(number, 'sent' or 'received', amount, party, note?) |
en kontoutskriftslinje i Wallet; den flytter ikke penger |
Scripts skrevet for en annen telefon kaller disse i stedet for den telefonens exports:
| Export | Hva den gjør |
|---|---|
ResolvePhone(target[, cb]) |
finner en telefon ut fra { source }, { number }, { email }, { identifier } eller { imei } |
DeliverMailTo(target, mail[, cb]) |
e-post til den telefonen: { sender, subject, body } |
SendText(from, to, body[, opts][, cb]) |
en tekstmelding fra en telefon eller fra en navngitt tjeneste |
DispatchAlert(jobs, { title, body, coords? }) |
et varsel til hvert medlem av de jobbene som er på vakt; den returnerer hvor mange den nådde |
Eksempel: et ranscript varsler politiet med en nål på kartet.
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-events
Lytt med AddEventHandler i et serverscript. Bare telefonen utløser dem; en client kan ikke forfalske dem.
| Event | Argumenter |
|---|---|
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: en knapp som din Notify tilbød, ble trykket |
Client-exports
| Export | Hva den gjør |
|---|---|
Open(), Close(), IsOpen() |
åpner eller lukker telefonen; Open respekterer alle blokkeringene nedenfor |
AddOpenCheck(fn) |
fn() som returnerer false hindrer telefonen i å åpne; fjernes når resourcen din stopper |
SetRestriction(key, mode) |
en egen spillerstatus: 'block', 'emergency-only' eller nil for å fjerne den |
SetCarAudio(state) |
viser bilstereoen din på Pulse Drive, bilskjermen |
GetPhoneNumber(), IsInCall(), GetBattery() |
denne spillerens egen telefon |
Eksempel: ingen telefon mens en spiller er i fengselet ditt.
exports.phone:SetRestriction('myjail', 'block') -- on entering the cell
exports.phone:SetRestriction('myjail', nil) -- on releaseState-bags
Serveren skriver disse til Player(src).state, med navnene andre telefonresources bruker, slik at HUD- og dispatch-scripts leser dem uendret: phoneNumber, phoneOpen, inCall, onCallWith, phoneBattery, phoneDead. Clients leser sin egen som LocalPlayer.state.phoneOpen.
Konfigurasjonseksempler
Telefonens innstillinger ligger i phone/config/. Tre som andre scripts er avhengige av:
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
}Dine egne apper
exports.phone:RegisterApp({ id, name, colour, icon, page = { kind = 'frame', url = 'ui/index.html' } }) legger til en app på Home Screen og i App Hub. Siden kjører i sin egen frame og snakker med serveren din via telefonen. Tillatelser, varsler, språk og oppføringen i App Hub er valgfrie felt. Hele guiden er Egne apper.
Notater om integrasjon
- Pulse Phone svarer selv på eventnavnene fra lb-phone, qb-phone og NPWD, så scripts som sender e-post, tekstmeldinger og varsler på den måten fungerer fortsatt. Scripts som kaller en annen telefons exports trenger én endring:
exports.phone. Se Bytte telefon. - Gi videre den ekte
sourcefra dine egne server-events. Ta aldri en spiller-id fra en client-melding. - Banking, garasjer, boliger og dispatch kobles til via telefonens bridges, som velges ved oppstart. Ditt eget script kan legges til som provider: Avanserte integrasjoner.
Ofte stilte spørsmål
Hva heter Pulse Phone-resourcen?
phone. Hver export er exports.phone:Name(...). Behold mappenavnet, fordi andre scripts og inventoryets item-hooks kaller den ved det navnet.
Fungerer scripts laget for lb-phone eller qb-phone med Pulse Phone?
Scripts som bruker de telefonenes events (e-post, tekstmeldinger, varsler, telefonnummer) fungerer uten endringer. Scripts som kaller exportene deres trenger exports.phone i stedet.
Kan jeg legge til min egen app i Pulse Phone?
Ja. Registrer den med RegisterApp fra resourcen din. Den vises i App Hub, og guiden dekker sider, tillatelser og varsler.