Документація Pulse Phone

API для розробників Pulse Phone

Pulse Phone надає іншим ресурсам серверний і клієнтський API: дізнатися номер гравця, надсилати SMS, пошту й сповіщення, здійснювати дзвінки, реагувати на те, що відбувається в телефоні, і додавати власні застосунки. Усе на цій сторінці взято з ресурсу phone у Pulse Phone 1.5.0. Повний список з усіма аргументами — у розділі Exports і події.

Для Pulse Phone 1.5.24 хв читанняОновлено

Де розташований API

Ресурс називається phone, тому кожен виклик має вигляд exports.phone:.... Дочекайтеся готовності телефона, перш ніж його використовувати: IsReady() повертає true, коли база даних відповідає, а телефон приймає запити.

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

phone_api у консолі сервера виводить короткий підсумок щодо API застосунків.

Найуживаніші серверні exports

Export Що воно робить
GetPhoneNumber(src) номер телефона, який тримає гравець, або nil, поки гравець не завантажився
SourceOfNumber(number) гравець онлайн із цим номером або nil
Notify(src, { title, body, app?, actions? }) сповіщення на телефоні цього гравця, до 3 кнопок
SendMessage(src, number, text) SMS від цього гравця на номер
SendMail(address, sender, subject, body) лист на адресу
Call(src, number, video?) здійснює дзвінок від імені цього гравця
SetPhoneDisabled(src, bool) вимикає або вмикає телефон гравця (в'язниця, катсцена)
RecordTransaction(number, 'sent' or 'received', amount, party, note?) рядок виписки в Гаманці; гроші він не переказує

Скрипти, написані для іншого телефона, викликають їх замість exports того телефона:

Export Що воно робить
ResolvePhone(target[, cb]) знаходить телефон за { source }, { number }, { email }, { identifier } або { imei }
DeliverMailTo(target, mail[, cb]) лист на цей телефон: { sender, subject, body }
SendText(from, to, body[, opts][, cb]) SMS з телефона або від іменованої служби
DispatchAlert(jobs, { title, body, coords? }) сповіщення кожному працівникові цих робіт, що перебуває на зміні; повертає, скільком воно дійшло

Приклад: скрипт пограбування сповіщає поліцію міткою на мапі.

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

Серверні події

Слухайте їх через AddEventHandler у серверному скрипті. Їх викликає лише телефон; клієнт не може їх підробити.

Подія Аргументи
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: натиснуто кнопку, яку запропонував ваш Notify

Клієнтські exports

Export Що воно робить
Open(), Close(), IsOpen() відкриває або закриває телефон; Open враховує всі блокування нижче
AddOpenCheck(fn) fn(), що повертає false, не дає телефону відкритися; знімається, коли ваш ресурс зупиняється
SetRestriction(key, mode) власний стан гравця: 'block', 'emergency-only' або nil, щоб скинути
SetCarAudio(state) показує вашу автомагнітолу в Pulse Drive, екрані авто
GetPhoneNumber(), IsInCall(), GetBattery() власний телефон цього гравця

Приклад: жодного телефона, поки гравець сидить у вашій в'язниці.

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

Стан гравця (state bags)

Сервер записує їх у Player(src).state під назвами, які використовують інші ресурси телефонів, тому скрипти HUD і диспетчеризації читають їх без змін: phoneNumber, phoneOpen, inCall, onCallWith, phoneBattery, phoneDead. Клієнти читають свої як LocalPlayer.state.phoneOpen.

Приклади конфігурації

Налаштування телефона розташовані в phone/config/. Три з них, від яких залежать інші скрипти:

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
}

Ваші власні застосунки

exports.phone:RegisterApp({ id, name, colour, icon, page = { kind = 'frame', url = 'ui/index.html' } }) додає застосунок на головний екран і в App Hub. Сторінка працює у власному фреймі й спілкується з вашим сервером через телефон. Дозволи, сповіщення, мови та картка в App Hub — необов'язкові поля. Повний посібник — Власні застосунки.

Нотатки щодо інтеграції

  • Pulse Phone сам відповідає на події lb-phone, qb-phone і NPWD, тому скрипти, що надсилають пошту, SMS і сповіщення таким способом, продовжують працювати. Скриптам, які викликають exports іншого телефона, потрібна одна правка: exports.phone. Див. Зміна телефона.
  • Передавайте справжній source зі своїх серверних подій. Ніколи не беріть id гравця з клієнтського повідомлення.
  • Банки, гаражі, житло й диспетчерська підключаються через мости телефона, які обираються під час запуску. Ваш власний скрипт можна додати як провайдера: Розширені інтеграції.

Поширені запитання

Як називається ресурс Pulse Phone?

phone. Кожен export викликається як exports.phone:Name(...). Не змінюйте назву папки: за нею до ресурсу звертаються інші скрипти та хуки предметів інвентаря.

Чи працюють з Pulse Phone скрипти, написані для lb-phone або qb-phone?

Скрипти, що використовують події цих телефонів (пошта, SMS, сповіщення, номер телефона), працюють без правок. Скриптам, які викликають їхні exports, натомість потрібен exports.phone.

Чи можна додати до Pulse Phone власний застосунок?

Так. Зареєструйте його через RegisterApp зі свого ресурсу. Він з'явиться в App Hub, а посібник охоплює сторінки, дозволи та сповіщення.

Перекладено з англійської. Якщо щось тут розходиться з англійською сторінкою, правильною є англійська сторінка. English