Dokumentace Pulse Phone

API pro vývojáře Pulse Phone

Pulse Phone dává ostatním resources serverové a klientské API: přečtěte číslo hráče, posílejte SMS, poštu a upozornění, volejte, reagujte na dění v telefonu a přidávejte vlastní aplikace. Vše na této stránce pochází z resource phone v Pulse Phone 1.5.0. Úplný seznam se všemi argumenty je v Exportech a eventech.

Pro Pulse Phone 1.5.24 min čteníAktualizováno

Kde API najdete

Resource se jmenuje phone, takže každé volání je exports.phone:.... Než telefon použijete, počkejte na něj: IsReady() se změní na true, jakmile odpoví databáze a telefon přijímá požadavky.

Lua
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 serveru vypíše krátké shrnutí API aplikací.

Nejpoužívanější serverové exporty

Export Co dělá
GetPhoneNumber(src) číslo telefonu, který hráč drží, nebo nil, dokud se nenačte
SourceOfNumber(number) online hráč s tímto číslem, nebo nil
Notify(src, { title, body, app?, actions? }) upozornění na telefonu daného hráče, až se 3 tlačítky
SendMessage(src, number, text) SMS od daného hráče na číslo
SendMail(address, sender, subject, body) pošta na adresu
Call(src, number, video?) zavolá za daného hráče
SetPhoneDisabled(src, bool) vypne nebo zapne telefon hráče (vězení, cutscéna)
RecordTransaction(number, 'sent' or 'received', amount, party, note?) řádek výpisu ve Wallet; nepřesouvá peníze

Scripty psané pro jiný telefon volají tyto místo exportů onoho telefonu:

Export Co dělá
ResolvePhone(target[, cb]) najde telefon podle { source }, { number }, { email }, { identifier } nebo { imei }
DeliverMailTo(target, mail[, cb]) pošta na ten telefon: { sender, subject, body }
SendText(from, to, body[, opts][, cb]) SMS z telefonu nebo od pojmenované služby
DispatchAlert(jobs, { title, body, coords? }) upozornění každému členovi těchto jobů, který je ve službě; vrátí, kolika lidem se dostalo

Příklad: script loupeže upozorní policii špendlíkem na mapě.

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

Serverové eventy

Poslouchejte přes AddEventHandler v serverovém scriptu. Vyvolává je jen telefon; klient je padělat nemůže.

Event Argumenty
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: bylo stisknuto tlačítko, které nabídl váš Notify

Klientské exporty

Export Co dělá
Open(), Close(), IsOpen() otevře nebo zavře telefon; Open respektuje všechna blokování níže
AddOpenCheck(fn) fn() vracející false zabrání otevření telefonu; odebere se, když se váš resource zastaví
SetRestriction(key, mode) vlastní stav hráče: 'block', 'emergency-only' nebo nil pro vymazání
SetCarAudio(state) zobrazí vaše autorádio na Pulse Drive, displeji auta
GetPhoneNumber(), IsInCall(), GetBattery() telefon tohoto hráče

Příklad: žádný telefon, dokud je hráč ve vašem vězení.

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

State bagy

Server je zapisuje do Player(src).state pod názvy, které používají jiné resources telefonů, takže HUD a dispatch scripty je čtou beze změny: phoneNumber, phoneOpen, inCall, onCallWith, phoneBattery, phoneDead. Klienti čtou své jako LocalPlayer.state.phoneOpen.

Příklady configu

Nastavení telefonu jsou v phone/config/. Tři, na kterých závisí jiné scripty:

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
}

Vaše vlastní aplikace

exports.phone:RegisterApp({ id, name, colour, icon, page = { kind = 'frame', url = 'ui/index.html' } }) přidá aplikaci na domovskou obrazovku a do App Hub. Stránka běží ve vlastním rámci a s vaším serverem mluví přes telefon. Oprávnění, upozornění, jazyky a záznam v App Hub jsou volitelná pole. Celý návod je Vlastní aplikace.

Poznámky k integraci

  • Pulse Phone sám odpovídá na názvy eventů z lb-phone, qb-phone a NPWD, takže scripty, které takto posílají poštu, SMS a upozornění, fungují dál. Scripty, které volají exporty jiného telefonu, potřebují jednu změnu: exports.phone. Viz Změna telefonu.
  • Předávejte skutečný source z vlastních serverových eventů. Nikdy nebraťte id hráče ze zprávy od klienta.
  • Banking, garáže, bydlení a dispatch se připojují přes mosty telefonu, které se vybírají při startu. Váš vlastní script lze přidat jako providera: Pokročilé integrace.

Časté dotazy

Jak se jmenuje resource Pulse Phone?

phone. Každý export je exports.phone:Name(...). Ponechte název složky, protože ho tímto názvem volají jiné scripty a hooky předmětů v inventáři.

Fungují scripty vytvořené pro lb-phone nebo qb-phone s Pulse Phone?

Scripty, které používají eventy těchto telefonů (pošta, SMS, upozornění, telefonní číslo), fungují bez úprav. Scripty, které volají jejich exporty, potřebují místo toho exports.phone.

Mohu do Pulse Phone přidat vlastní aplikaci?

Ano. Zaregistrujte ji přes RegisterApp ze svého resource. Objeví se v App Hub a návod pokrývá stránky, oprávnění a upozornění.

Přeloženo z angličtiny. Pokud se zde něco liší od anglické stránky, platí anglická stránka. English