Dokumentation för Pulse Phone

Utvecklar-API för Pulse Phone

Pulse Phone ger andra resources ett server- och klient-API: läs en spelares nummer, skicka sms, mejl och notiser, ring samtal, reagera på det som händer i telefonen och lägg till egna appar. Allt på den här sidan är hämtat från phone-resursen i Pulse Phone 1.5.0. Den fullständiga listan, med alla argument, finns på Exports och events.

För Pulse Phone 1.5.24 min läsningUppdaterad

Var API:et finns

Resursen heter phone, så varje anrop är exports.phone:.... Vänta på telefonen innan du använder den: IsReady() blir true när databasen svarar och telefonen tar emot förfrågningar.

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

phone_api i serverkonsolen skriver ut en kort sammanfattning av app-API:et.

Mest använda server-exports

Export Vad den gör
GetPhoneNumber(src) numret på telefonen spelaren har, eller nil tills spelaren har laddats
SourceOfNumber(number) spelaren online med det numret, eller nil
Notify(src, { title, body, app?, actions? }) en notis på den spelarens telefon, med upp till 3 knappar
SendMessage(src, number, text) ett sms från den spelaren till ett nummer
SendMail(address, sender, subject, body) ett mejl till en adress
Call(src, number, video?) ringer ett samtal för den spelaren
SetPhoneDisabled(src, bool) stänger av eller sätter på en spelares telefon (fängelse, en cutscene)
RecordTransaction(number, 'sent' or 'received', amount, party, note?) en kontoutdragsrad i Wallet; den flyttar inga pengar

Scripts skrivna för en annan telefon anropar dessa i stället för den telefonens exports:

Export Vad den gör
ResolvePhone(target[, cb]) hittar en telefon via { source }, { number }, { email }, { identifier } eller { imei }
DeliverMailTo(target, mail[, cb]) mejl till den telefonen: { sender, subject, body }
SendText(from, to, body[, opts][, cb]) ett sms från en telefon, eller från en namngiven tjänst
DispatchAlert(jobs, { title, body, coords? }) en varning till varje medlem i de jobben som är i tjänst; den returnerar hur många den nådde

Exempel: ett rånscript larmar polisen med en kartnål.

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

Server-events

Lyssna med AddEventHandler i ett serverscript. Bara telefonen utlöser dem; en klient kan inte förfalska dem.

Event Argument
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 erbjöd trycktes

Klient-exports

Export Vad den gör
Open(), Close(), IsOpen() öppnar eller stänger telefonen; Open respekterar alla blockeringar nedan
AddOpenCheck(fn) fn() som returnerar false hindrar telefonen från att öppnas; tas bort när din resurs stoppas
SetRestriction(key, mode) ett eget spelartillstånd: 'block', 'emergency-only' eller nil för att rensa det
SetCarAudio(state) visar din bilstereo på Pulse Drive, bilens skärm
GetPhoneNumber(), IsInCall(), GetBattery() den här spelarens egen telefon

Exempel: ingen telefon medan en spelare sitter i ditt fängelse.

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

Statebags

Servern skriver dessa till Player(src).state, med de namn som andra telefonresurser använder, så att HUD- och dispatch-scripts läser dem oförändrade: phoneNumber, phoneOpen, inCall, onCallWith, phoneBattery, phoneDead. Klienter läser sina egna som LocalPlayer.state.phoneOpen.

Config-exempel

Telefonens inställningar finns i phone/config/. Tre som andra scripts är beroende av:

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
}

Dina egna appar

exports.phone:RegisterApp({ id, name, colour, icon, page = { kind = 'frame', url = 'ui/index.html' } }) lägger till en app på startskärmen och i App Hub. Sidan körs i en egen frame och pratar med din server via telefonen. Behörigheter, notiser, språk och listningen i App Hub är valfria fält. Hela guiden är Egna appar.

Integrationsanteckningar

  • Pulse Phone svarar själv på event-namnen från lb-phone, qb-phone och NPWD, så scripts som skickar mejl, sms och varningar på det sättet fortsätter fungera. Scripts som anropar en annan telefons exports behöver en ändring: exports.phone. Se Byt telefon.
  • Skicka den riktiga source från dina egna server-events. Ta aldrig ett spelar-id från ett klientmeddelande.
  • Banking, garage, bostäder och dispatch kopplas in via telefonens bridges, som väljs vid start. Ditt eget script kan läggas till som provider: Avancerade integrationer.

Vanliga frågor

Vad heter Pulse Phone-resursen?

phone. Varje export är exports.phone:Name(...). Behåll mappnamnet, eftersom andra scripts och inventoryts item-hooks anropar den med det namnet.

Fungerar scripts gjorda för lb-phone eller qb-phone med Pulse Phone?

Scripts som använder de telefonernas events (mejl, sms, notiser, telefonnummer) fungerar utan ändringar. Scripts som anropar deras exports behöver exports.phone i stället.

Kan jag lägga till min egen app i Pulse Phone?

Ja. Registrera den med RegisterApp från din resurs. Den visas i App Hub, och guiden går igenom sidor, behörigheter och notiser.

Översatt från engelska. Om något här skiljer sig från den engelska sidan är det den engelska sidan som gäller. English