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

API для разработчиков Pulse Phone

Pulse Phone даёт другим ресурсам серверный и клиентский API: узнать номер игрока, отправлять SMS, почту и уведомления, совершать звонки, реагировать на то, что происходит в телефоне, и добавлять собственные приложения. Всё на этой странице взято из ресурса phone в Pulse Phone 1.5.0. Полный список со всеми аргументами — в разделе Экспорты и события.

Для 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 приложений.

Самые используемые серверные экспорты

Экспорт Что она делает
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?) строка выписки в Кошельке; деньги она не переводит

Скрипты, написанные для другого телефона, вызывают их вместо экспортов того телефона:

Экспорт Что она делает
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

Клиентские экспорты

Экспорт Что она делает
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.phone. См. Смена телефона.
  • Передавайте настоящий source из собственных серверных событий. Никогда не берите id игрока из клиентского сообщения.
  • Банки, гаражи, жильё и диспетчерская подключаются через мосты телефона, которые выбираются при запуске. Ваш собственный скрипт можно добавить как провайдера: Расширенные интеграции.

Частые вопросы

Как называется ресурс Pulse Phone?

phone. Каждый экспорт вызывается как exports.phone:Name(...). Не меняйте название папки: по нему к ресурсу обращаются другие скрипты и хуки предметов инвентаря.

Работают ли с Pulse Phone скрипты, написанные для lb-phone или qb-phone?

Скрипты, использующие события этих телефонов (почта, SMS, уведомления, номер телефона), работают без правок. Скриптам, вызывающим их экспорты, вместо этого нужен exports.phone.

Можно ли добавить в Pulse Phone собственное приложение?

Да. Зарегистрируйте его через RegisterApp из своего ресурса. Оно появится в App Hub, а руководство охватывает страницы, разрешения и уведомления.

Переведено с английского. Если что-то здесь расходится с английской страницей, верна английская страница. English