Pulse Phone Doku

Pulse-Phone-Developer-API

Pulse Phone gibt anderen Resources eine Server- und Client-API: die Nummer eines Spielers lesen, Texte, Mails und Benachrichtigungen senden, Anrufe starten, auf Ereignisse am Telefon reagieren und eigene Apps hinzufügen. Alles auf dieser Seite stammt aus der Phone-Resource von Pulse Phone 1.5.0. Die vollständige Liste mit allen Argumenten steht unter Exports und Events.

Für Pulse Phone 1.5.24 Min. LesezeitAktualisiert am

Wo die API liegt

Die Resource heißt phone, daher ist jeder Aufruf exports.phone:.... Warte auf das Telefon, bevor du es nutzt: IsReady() wird true, sobald die Datenbank antwortet und das Telefon Anfragen annimmt.

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 der Serverkonsole gibt eine kurze Übersicht der App-API aus.

Die am häufigsten genutzten Server-Exports

Export Was sie macht
GetPhoneNumber(src) die Nummer des Telefons, das der Spieler hält, oder nil, bis er geladen ist
SourceOfNumber(number) der Online-Spieler mit dieser Nummer, oder nil
Notify(src, { title, body, app?, actions? }) eine Benachrichtigung auf dem Telefon dieses Spielers, mit bis zu 3 Buttons
SendMessage(src, number, text) ein Text von diesem Spieler an eine Nummer
SendMail(address, sender, subject, body) eine Mail an eine Adresse
Call(src, number, video?) startet einen Anruf für diesen Spieler
SetPhoneDisabled(src, bool) schaltet das Telefon eines Spielers aus oder ein (Gefängnis, Zwischensequenz)
RecordTransaction(number, 'sent' or 'received', amount, party, note?) eine Kontoauszugszeile im Wallet; es bewegt kein Geld

Scripts, die für ein anderes Telefon geschrieben wurden, rufen stattdessen diese auf, statt der Exports jenes Telefons:

Export Was sie macht
ResolvePhone(target[, cb]) findet ein Telefon über { source }, { number }, { email }, { identifier } oder { imei }
DeliverMailTo(target, mail[, cb]) Mail an dieses Telefon: { sender, subject, body }
SendText(from, to, body[, opts][, cb]) ein Text von einem Telefon oder von einem benannten Dienst
DispatchAlert(jobs, { title, body, coords? }) eine Meldung an jedes diensthabende Mitglied dieser Jobs; gibt zurück, wie viele erreicht wurden

Beispiel: Ein Raub-Script alarmiert die Polizei mit einem Kartenpunkt.

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

Höre mit AddEventHandler in einem Server-Script zu. Nur das Telefon löst sie aus; ein Client kann sie nicht fälschen.

Event Argumente
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: Ein Button, den dein Notify angeboten hat, wurde gedrückt

Client-Exports

Export Was sie macht
Open(), Close(), IsOpen() öffnet oder schließt das Telefon; Open beachtet jede Sperre unten
AddOpenCheck(fn) fn() gibt false zurück und verhindert so das Öffnen des Telefons; wird entfernt, wenn deine Resource stoppt
SetRestriction(key, mode) ein eigener Spielerzustand: 'block', 'emergency-only' oder nil zum Zurücksetzen
SetCarAudio(state) zeigt deine Auto-Stereoanlage auf Pulse Drive, dem Auto-Display
GetPhoneNumber(), IsInCall(), GetBattery() das eigene Telefon dieses Spielers

Beispiel: kein Telefon, solange ein Spieler in deinem Gefängnis ist.

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

State Bags

Der Server schreibt diese nach Player(src).state, mit den Namen, die andere Phone-Resources nutzen, damit HUD- und Dispatch-Scripts sie unverändert lesen: phoneNumber, phoneOpen, inCall, onCallWith, phoneBattery, phoneDead. Clients lesen ihre eigenen als LocalPlayer.state.phoneOpen.

Config-Beispiele

Die Einstellungen des Telefons liegen in phone/config/. Drei, auf die sich andere Scripts verlassen:

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
}

Deine eigenen Apps

exports.phone:RegisterApp({ id, name, colour, icon, page = { kind = 'frame', url = 'ui/index.html' } }) fügt dem Homescreen und dem App Hub eine App hinzu. Die Seite läuft in einem eigenen Frame und spricht über das Telefon mit deinem Server. Berechtigungen, Benachrichtigungen, Sprachen und der Eintrag im App Hub sind optionale Felder. Die vollständige Anleitung steht unter Eigene Apps.

Hinweise zur Integration

  • Pulse Phone beantwortet die Event-Namen von lb-phone, qb-phone und NPWD selbst, daher funktionieren Scripts, die Mails, Texte und Meldungen auf diesem Weg senden, weiter. Scripts, die die Exports eines anderen Telefons aufrufen, brauchen eine Änderung: exports.phone. Siehe Telefone wechseln.
  • Übergib den echten source aus deinen eigenen Server-Events. Nimm nie eine Spieler-ID aus einer Client-Nachricht.
  • Banking, Garagen, Housing und Dispatch werden über die Bridges des Telefons verbunden, die beim Start ausgewählt werden. Dein eigenes Script kann als Provider hinzugefügt werden: Erweiterte Integrationen.

Häufig gestellte Fragen

Wie heißt die Pulse-Phone-Resource?

phone. Jeder Export ist exports.phone:Name(...). Behalte den Ordnernamen, weil andere Scripts und die Inventar-Item-Hooks sie unter diesem Namen aufrufen.

Funktionieren für lb-phone oder qb-phone gebaute Scripts mit Pulse Phone?

Scripts, die die Events dieser Telefone nutzen (Mail, Texte, Benachrichtigungen, Telefonnummer), funktionieren ohne Änderungen. Scripts, die deren Exports aufrufen, brauchen stattdessen exports.phone.

Kann ich meine eigene App zu Pulse Phone hinzufügen?

Ja. Registriere sie mit RegisterApp aus deiner Resource. Sie erscheint im App Hub, und die Anleitung behandelt Seiten, Berechtigungen und Benachrichtigungen.

Aus dem Englischen übersetzt. Wenn etwas hier von der englischen Seite abweicht, gilt die englische Seite. English