Pulse Phone-dokumentation
Pulse Phone udvikler-API
Pulse Phone giver andre resources et server- og client-API: læs en spillers nummer, send sms'er, mail og notifikationer, ring op, reagér på det, der sker på telefonen, og tilføj dine egne apps. Alt på denne side er hentet fra phone-resourcen i Pulse Phone 1.5.0. Den komplette liste med alle argumenter står på Exports og events.
Hvor API'et findes
Resourcen hedder phone, så hvert kald er exports.phone:.... Vent på telefonen, før du bruger den: IsReady() bliver true, når databasen svarer, og telefonen tager imod forespørgsler.
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 en kort oversigt over app-API'et.
Mest brugte server-exports
| Export | Hvad den gør |
|---|---|
GetPhoneNumber(src) |
nummeret på den telefon, spilleren har, eller nil, indtil spilleren er indlæst |
SourceOfNumber(number) |
den online spiller med det nummer, eller nil |
Notify(src, { title, body, app?, actions? }) |
en notifikation på den spillers telefon, med op til 3 knapper |
SendMessage(src, number, text) |
en sms fra den spiller til et nummer |
SendMail(address, sender, subject, body) |
en mail til en adresse |
Call(src, number, video?) |
starter et opkald for den spiller |
SetPhoneDisabled(src, bool) |
slår en spillers telefon fra eller til (et fængsel, en cutscene) |
RecordTransaction(number, 'sent' or 'received', amount, party, note?) |
en kontoudtogslinje i Wallet; den flytter ikke penge |
Scripts skrevet til en anden telefon kalder disse i stedet for den telefons exports:
| Export | Hvad den gør |
|---|---|
ResolvePhone(target[, cb]) |
finder en telefon ud fra { source }, { number }, { email }, { identifier } eller { imei } |
DeliverMailTo(target, mail[, cb]) |
mail til den telefon: { sender, subject, body } |
SendText(from, to, body[, opts][, cb]) |
en sms fra en telefon eller fra en navngivet tjeneste |
DispatchAlert(jobs, { title, body, coords? }) |
en alarm til alle medlemmer af de jobs, der er på vagt; den returnerer, hvor mange den nåede |
Eksempel: et røveriscript alarmerer politiet med en nål på kortet.
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
Lyt med AddEventHandler i et serverscript. Kun telefonen udlø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 knap, som din Notify tilbød, blev trykket |
Client-exports
| Export | Hvad den gør |
|---|---|
Open(), Close(), IsOpen() |
åbner eller lukker telefonen; Open respekterer alle blokeringer nedenfor |
AddOpenCheck(fn) |
fn(), der returnerer false, forhindrer telefonen i at åbne; fjernes, når din resource stopper |
SetRestriction(key, mode) |
en egen spillerstatus: 'block', 'emergency-only' eller nil for at rydde den |
SetCarAudio(state) |
viser din bilstereo på Pulse Drive, bilens skærm |
GetPhoneNumber(), IsInCall(), GetBattery() |
denne spillers egen telefon |
Eksempel: ingen telefon, mens en spiller sidder i dit fængsel.
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 de navne, andre telefonresources bruger, så HUD- og dispatch-scripts læser dem uændret: phoneNumber, phoneOpen, inCall, onCallWith, phoneBattery, phoneDead. Clients læser deres egen som LocalPlayer.state.phoneOpen.
Konfigurationseksempler
Telefonens indstillinger står i phone/config/. Tre, som andre scripts afhænger af:
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 apps
exports.phone:RegisterApp({ id, name, colour, icon, page = { kind = 'frame', url = 'ui/index.html' } }) tilføjer en app til Home Screen og App Hub. Siden kører i sin egen frame og taler med din server via telefonen. Tilladelser, notifikationer, sprog og opførelsen i App Hub er valgfrie felter. Den fulde guide er Egne apps.
Noter om integration
- Pulse Phone besvarer selv event-navnene fra lb-phone, qb-phone og NPWD, så scripts, der sender mail, sms'er og alarmer den vej, virker stadig. Scripts, der kalder en anden telefons exports, skal rettes én gang:
exports.phone. Se Skift af telefon. - Giv den rigtige
sourcevidere fra dine egne server-events. Tag aldrig et spiller-id fra en client-besked. - Banking, garager, boliger og dispatch forbindes via telefonens bridges, som vælges ved opstart. Dit eget script kan tilføjes som provider: Avancerede integrationer.
Ofte stillede spørgsmål
Hvad hedder Pulse Phone-resourcen?
phone. Hver export er exports.phone:Name(...). Behold mappenavnet, fordi andre scripts og inventoryets item-hooks kalder den ved det navn.
Virker scripts lavet til lb-phone eller qb-phone med Pulse Phone?
Scripts, der bruger de telefoners events (mail, sms'er, notifikationer, telefonnummer), virker uden rettelser. Scripts, der kalder deres exports, skal i stedet bruge exports.phone.
Kan jeg tilføje min egen app til Pulse Phone?
Ja. Registrér den med RegisterApp fra din resource. Den vises i App Hub, og guiden dækker sider, tilladelser og notifikationer.