Dokumentacja Pulse Phone

API dla deweloperów Pulse Phone

Pulse Phone daje innym resource'om API serwerowe i klienckie: odczytaj numer gracza, wysyłaj SMS-y, pocztę i powiadomienia, wykonuj połączenia, reaguj na to, co dzieje się w telefonie, i dodawaj własne aplikacje. Wszystko na tej stronie pochodzi z resource phone w Pulse Phone 1.5.0. Pełna lista ze wszystkimi argumentami jest w Eksportach i eventach.

Dla Pulse Phone 1.5.24 min czytaniaAktualizacja

Gdzie jest API

Resource nazywa się phone, więc każde wywołanie to exports.phone:.... Poczekaj na telefon, zanim go użyjesz: IsReady() zwraca true, gdy baza danych odpowiada, a telefon przyjmuje żądania.

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

phone_api w konsoli serwera wypisuje krótkie podsumowanie API aplikacji.

Najczęściej używane eksporty serwerowe

Eksport Co robi
GetPhoneNumber(src) numer telefonu, który gracz trzyma, albo nil, dopóki się nie załaduje
SourceOfNumber(number) gracz online z tym numerem albo nil
Notify(src, { title, body, app?, actions? }) powiadomienie na telefonie tego gracza, z maksymalnie 3 przyciskami
SendMessage(src, number, text) SMS od tego gracza na numer
SendMail(address, sender, subject, body) poczta na adres
Call(src, number, video?) wykonuje połączenie dla tego gracza
SetPhoneDisabled(src, bool) wyłącza lub włącza telefon gracza (więzienie, cutscenka)
RecordTransaction(number, 'sent' or 'received', amount, party, note?) wiersz wyciągu w Wallet; nie przenosi pieniędzy

Skrypty napisane dla innego telefonu wywołują je zamiast eksportów tamtego telefonu:

Eksport Co robi
ResolvePhone(target[, cb]) znajduje telefon po { source }, { number }, { email }, { identifier } lub { imei }
DeliverMailTo(target, mail[, cb]) poczta na ten telefon: { sender, subject, body }
SendText(from, to, body[, opts][, cb]) SMS z telefonu albo od nazwanej usługi
DispatchAlert(jobs, { title, body, coords? }) alert do każdego członka tych jobów będącego na służbie; zwraca, do ilu osób dotarł

Przykład: skrypt napadu alarmuje policję pinezką na mapie.

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

Eventy serwerowe

Nasłuchuj przez AddEventHandler w skrypcie serwerowym. Wywołuje je tylko telefon; klient nie może ich sfałszować.

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: naciśnięto przycisk, który zaoferował twój Notify

Eksporty klienckie

Eksport Co robi
Open(), Close(), IsOpen() otwiera lub zamyka telefon; Open respektuje wszystkie blokady poniżej
AddOpenCheck(fn) fn() zwracające false powstrzymuje otwarcie telefonu; usuwane, gdy twój resource się zatrzyma
SetRestriction(key, mode) własny stan gracza: 'block', 'emergency-only' albo nil, aby go wyczyścić
SetCarAudio(state) pokazuje twoje radio samochodowe w Pulse Drive, na ekranie auta
GetPhoneNumber(), IsInCall(), GetBattery() własny telefon tego gracza

Przykład: brak telefonu, gdy gracz siedzi w twoim więzieniu.

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

State bagi

Serwer zapisuje je w Player(src).state pod nazwami używanymi przez inne resource'y telefonów, więc skrypty HUD i dispatch czytają je bez zmian: phoneNumber, phoneOpen, inCall, onCallWith, phoneBattery, phoneDead. Klienci czytają swoje jako LocalPlayer.state.phoneOpen.

Przykłady configu

Ustawienia telefonu są w phone/config/. Trzy, od których zależą inne skrypty:

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
}

Twoje własne aplikacje

exports.phone:RegisterApp({ id, name, colour, icon, page = { kind = 'frame', url = 'ui/index.html' } }) dodaje aplikację do ekranu głównego i App Hub. Strona działa we własnej ramce i rozmawia z twoim serwerem przez telefon. Uprawnienia, powiadomienia, języki i wpis w App Hub to pola opcjonalne. Pełny poradnik to Własne aplikacje.

Uwagi o integracji

  • Pulse Phone sam odpowiada na nazwy eventów lb-phone, qb-phone i NPWD, więc skrypty wysyłające w ten sposób pocztę, SMS-y i alerty działają dalej. Skrypty wywołujące eksporty innego telefonu wymagają jednej zmiany: exports.phone. Zobacz Zmiana telefonu.
  • Przekazuj prawdziwy source z własnych eventów serwerowych. Nigdy nie bierz id gracza z wiadomości od klienta.
  • Bankowość, garaże, mieszkania i dispatch są podłączane przez mosty telefonu, wybierane przy starcie. Twój własny skrypt można dodać jako providera: Zaawansowane integracje.

Najczęściej zadawane pytania

Jak nazywa się resource Pulse Phone?

phone. Każdy eksport to exports.phone:Name(...). Zachowaj nazwę folderu, bo inne skrypty i hooki przedmiotów w ekwipunku wywołują go pod tą nazwą.

Czy skrypty napisane dla lb-phone lub qb-phone działają z Pulse Phone?

Skrypty używające eventów tych telefonów (poczta, SMS-y, powiadomienia, numer telefonu) działają bez zmian. Skrypty wywołujące ich eksporty potrzebują zamiast tego exports.phone.

Czy mogę dodać własną aplikację do Pulse Phone?

Tak. Zarejestruj ją przez RegisterApp ze swojego resource. Pojawi się w App Hub, a poradnik opisuje strony, uprawnienia i powiadomienia.

Przetłumaczone z angielskiego. Jeśli coś tutaj różni się od strony angielskiej, rację ma strona angielska. English