Docs van Pulse Phone

Pulse Phone developer-API

Pulse Phone geeft andere resources een server- en client-API: lees het nummer van een speler, stuur sms-berichten, mail en meldingen, bel, reageer op wat er op de telefoon gebeurt en voeg eigen apps toe. Alles op deze pagina komt uit de phone-resource van Pulse Phone 1.5.0. De volledige lijst, met elk argument, staat op Exports en events.

Voor Pulse Phone 1.5.24 min leestijdBijgewerkt

Waar de API zit

De resource heet phone, dus elke aanroep is exports.phone:.... Wacht op de telefoon voordat je hem gebruikt: IsReady() wordt true zodra de database antwoordt en de telefoon verzoeken aanneemt.

Lua
CreateThread(function()
    while GetResourceState('phone') ~= 'started' or not exports.phone:IsReady() do Wait(500) end
    print('Pulse Phone is ready')
end)

phone_api in de serverconsole toont een korte samenvatting van de app-API.

Meest gebruikte server-exports

Export Wat het doet
GetPhoneNumber(src) het nummer van de telefoon die de speler vasthoudt, of nil totdat de speler geladen is
SourceOfNumber(number) de online speler met dat nummer, of nil
Notify(src, { title, body, app?, actions? }) een melding op de telefoon van die speler, met maximaal 3 knoppen
SendMessage(src, number, text) een sms van die speler naar een nummer
SendMail(address, sender, subject, body) een mail naar een adres
Call(src, number, video?) start een gesprek voor die speler
SetPhoneDisabled(src, bool) zet de telefoon van een speler uit of aan (gevangenis, een cutscene)
RecordTransaction(number, 'sent' or 'received', amount, party, note?) een afschriftregel in Wallet; er wordt geen geld verplaatst

Scripts die voor een andere telefoon zijn geschreven roepen deze aan in plaats van de exports van die telefoon:

Export Wat het doet
ResolvePhone(target[, cb]) vindt een telefoon op basis van { source }, { number }, { email }, { identifier } of { imei }
DeliverMailTo(target, mail[, cb]) mail naar die telefoon: { sender, subject, body }
SendText(from, to, body[, opts][, cb]) een sms van een telefoon of van een benoemde dienst
DispatchAlert(jobs, { title, body, coords? }) een melding aan elk dienstdoend lid van die jobs; het geeft terug hoeveel er zijn bereikt

Voorbeeld: een overvalscript waarschuwt de politie met een pin op de kaart.

Lua
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),
})

Serverevents

Luister met AddEventHandler in een serverscript. Alleen de telefoon activeert ze; een client kan ze niet vervalsen.

Event Argumenten
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: een knop die je Notify aanbood is ingedrukt

Client-exports

Export Wat het doet
Open(), Close(), IsOpen() opent of sluit de telefoon; Open houdt rekening met elke blokkade hieronder
AddOpenCheck(fn) fn() die false teruggeeft voorkomt dat de telefoon opent; verwijderd wanneer je resource stopt
SetRestriction(key, mode) een eigen speler-state van jou: 'block', 'emergency-only' of nil om hem te wissen
SetCarAudio(state) toont je autoradio op Pulse Drive, het autoscherm
GetPhoneNumber(), IsInCall(), GetBattery() de eigen telefoon van deze speler

Voorbeeld: geen telefoon zolang een speler in jouw gevangenis zit.

Lua
exports.phone:SetRestriction('myjail', 'block')   -- on entering the cell
exports.phone:SetRestriction('myjail', nil)       -- on release

State-bags

De server schrijft deze naar Player(src).state, met de namen die andere telefoonresources gebruiken, zodat HUD- en dispatchscripts ze ongewijzigd lezen: phoneNumber, phoneOpen, inCall, onCallWith, phoneBattery, phoneDead. Clients lezen hun eigen waarde als LocalPlayer.state.phoneOpen.

Configvoorbeelden

De instellingen van de telefoon staan in phone/config/. Drie waar andere scripts van afhangen:

Lua
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
}

Je eigen apps

exports.phone:RegisterApp({ id, name, colour, icon, page = { kind = 'frame', url = 'ui/index.html' } }) voegt een app toe aan het Home Screen en de App Hub. De pagina draait in een eigen frame en praat via de telefoon met je server. Rechten, meldingen, talen en de vermelding in de App Hub zijn optionele velden. De volledige gids is Eigen apps.

Integratienotities

  • Pulse Phone beantwoordt zelf de eventnamen van lb-phone, qb-phone en NPWD, dus scripts die op die manier mail, sms-berichten en meldingen sturen blijven werken. Scripts die de exports van een andere telefoon aanroepen hebben één aanpassing nodig: exports.phone. Zie Van telefoon wisselen.
  • Geef de echte source mee vanuit je eigen serverevents. Neem nooit een speler-id over uit een clientbericht.
  • Banking, garages, woningen en dispatch worden bij het opstarten via de bridges van de telefoon gekoppeld. Je eigen script kan als provider worden toegevoegd: Geavanceerde integraties.

Veelgestelde vragen

Hoe heet de Pulse Phone-resource?

phone. Elke export is exports.phone:Name(...). Houd de mapnaam ongewijzigd, want andere scripts en de item-hooks van de inventory roepen hem onder die naam aan.

Werken scripts voor lb-phone of qb-phone met Pulse Phone?

Scripts die de events van die telefoons gebruiken (mail, sms-berichten, meldingen, telefoonnummer) werken zonder aanpassingen. Scripts die hun exports aanroepen hebben in plaats daarvan exports.phone nodig.

Kan ik mijn eigen app aan Pulse Phone toevoegen?

Ja. Registreer hem met RegisterApp vanuit je resource. Hij verschijnt in de App Hub en de gids behandelt pagina's, rechten en meldingen.

Vertaald uit het Engels. Als iets hier afwijkt van de Engelse pagina, dan heeft de Engelse pagina gelijk. English