Pulse Phone dokumentáció
Pulse Phone fejlesztői API
A Pulse Phone szerver és kliens API-t ad más resource-oknak: kiolvashatod egy játékos számát, küldhetsz üzeneteket, leveleket és értesítéseket, indíthatsz hívásokat, reagálhatsz a telefonon történtekre, és hozzáadhatod a saját alkalmazásaidat. Minden, ami ezen az oldalon van, a Pulse Phone 1.5.0 phone resource-ából származik. A teljes lista minden argumentummal itt van: Exportok és eventek.
Hol található az API
A resource neve: phone, ezért minden hívás így néz ki: exports.phone:.... Használat előtt várd meg a telefont:
IsReady() true lesz, amint az adatbázis válaszol és a telefon fogad kéréseket.
CreateThread(function()
while GetResourceState('phone') ~= 'started' or not exports.phone:IsReady() do Wait(500) end
print('Pulse Phone is ready')
end)phone_api a szerver konzolján kiír egy rövid összefoglalót az alkalmazás API-ról.
A leggyakrabban használt szerver exportok
| Export | Mit csinál |
|---|---|
GetPhoneNumber(src) |
a játékos kezében lévő telefon száma, vagy nil, amíg be nem töltődnek |
SourceOfNumber(number) |
az adott számú online játékos, vagy nil |
Notify(src, { title, body, app?, actions? }) |
értesítés a játékos telefonján, legfeljebb 3 gombbal |
SendMessage(src, number, text) |
üzenet az adott játékostól egy számra |
SendMail(address, sender, subject, body) |
levél egy címre |
Call(src, number, video?) |
hívást indít az adott játékosnak |
SetPhoneDisabled(src, bool) |
ki- vagy bekapcsolja egy játékos telefonját (börtön, átvezető jelenet) |
RecordTransaction(number, 'sent' or 'received', amount, party, note?) |
egy kivonatsor a Wallet-ben; pénzt nem mozgat |
A másik telefonra írt scriptek ezeket hívják a telefon exportjai helyett:
| Export | Mit csinál |
|---|---|
ResolvePhone(target[, cb]) |
megtalál egy telefont ez alapján: { source }, { number }, { email }, { identifier } vagy { imei } |
DeliverMailTo(target, mail[, cb]) |
levél arra a telefonra: { sender, subject, body } |
SendText(from, to, body[, opts][, cb]) |
üzenet egy telefonról vagy egy megnevezett szolgáltatástól |
DispatchAlert(jobs, { title, body, coords? }) |
riasztás az adott munkák minden szolgálatban lévő tagjának; visszaadja, hányat ért el |
Példa: egy rablás script térképjelölővel riasztja a rendőrséget.
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),
})Szerver eventek
Figyeld ezzel: AddEventHandler egy szerver scriptben. Csak a telefon váltja ki őket; egy kliens nem tudja meghamisítani.
| Event | Argumentumok |
|---|---|
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: megnyomtak egy gombot, amelyet a(z) Notify ajánlott fel |
Kliens exportok
| Export | Mit csinál |
|---|---|
Open(), Close(), IsOpen() |
megnyitja vagy bezárja a telefont; az Open minden alábbi blokkolást tiszteletben tart |
AddOpenCheck(fn) |
fn() false-t visszaadva megakadályozza a telefon megnyitását; a resource leállásakor eltávolítódik |
SetRestriction(key, mode) |
a játékos saját állapota: 'block', 'emergency-only' vagy nil a törléshez |
SetCarAudio(state) |
megmutatja az autórádiódat a Pulse Drive-on, az autó képernyőjén |
GetPhoneNumber(), IsInCall(), GetBattery() |
ennek a játékosnak a saját telefonja |
Példa: nincs telefon, amíg a játékos a börtönödben van.
exports.phone:SetRestriction('myjail', 'block') -- on entering the cell
exports.phone:SetRestriction('myjail', nil) -- on releaseState bagek
A szerver ide írja ezeket: Player(src).state, a más telefon resource-ok által használt nevekkel, így a HUD és diszpécser scriptek változtatás nélkül olvassák őket: phoneNumber, phoneOpen, inCall, onCallWith, phoneBattery,
phoneDead. A kliensek a sajátjukat így olvassák: LocalPlayer.state.phoneOpen.
Konfigurációs példák
A telefon beállításai itt vannak: phone/config/. Három, amitől más scriptek függnek:
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
}Saját alkalmazásaid
exports.phone:RegisterApp({ id, name, colour, icon, page = { kind = 'frame', url = 'ui/index.html' } })
felvesz egy alkalmazást a kezdőképernyőre és az App Hubra. Az oldal a saját keretében fut, és a telefonon át beszél a szerveroddal. Az engedélyek, értesítések, nyelvek és az App Hub-listázás opcionális mezők. A teljes útmutató: Egyedi alkalmazások.
Integrációs jegyzetek
- A Pulse Phone magától válaszol az lb-phone, qb-phone és NPWD event neveire, így az ilyen módon leveleket, üzeneteket és riasztásokat küldő scriptek tovább működnek. A másik telefon exportjait hívó scriptekhez egy változtatás kell:
exports.phone. Lásd: Telefonváltás. - Add át a valódi
sourceértéket a saját szerver eventjeidből. Soha ne vegyél játékos azonosítót kliensüzenetből. - A banki, garázs-, lakás- és diszpécser rendszerek a telefon hídjain keresztül csatlakoznak, indításkor kiválasztva. A saját scriptedet providerként is hozzáadhatod: Haladó integrációk.
Gyakran ismételt kérdések
Hogy hívják a Pulse Phone resource-t?
phone. Minden export így néz ki: exports.phone:Name(...). Tartsd meg a mappa nevét, mert más scriptek és az inventory tárgy hookjai ezen a néven hívják.
Működnek a Pulse Phone-nal az lb-phone-hoz vagy qb-phone-hoz készült scriptek?
Azok a scriptek, amelyek ezeknek a telefonoknak az eventjeit használják (levél, üzenet, értesítés, telefonszám), szerkesztés nélkül működnek. Azok, amelyek az exportjaikat hívják, ezt igénylik helyette: exports.phone.
Hozzáadhatom a saját alkalmazásomat a Pulse Phone-hoz?
Igen. Regisztráld ezzel: RegisterApp a resource-odból. Megjelenik az App Hubban, az útmutató pedig az oldalakat, engedélyeket és értesítéseket is tárgyalja.