Documentação do Pulse Phone

API para programadores do Pulse Phone

O Pulse Phone oferece aos outros resources uma API de servidor e de cliente: ler o número de um jogador, enviar mensagens, e-mails e notificações, fazer chamadas, reagir ao que acontece no telemóvel e adicionar apps próprias. Tudo nesta página vem do resource phone do Pulse Phone 1.5.0. A lista completa, com todos os argumentos, está em Exports e eventos.

Para o Pulse Phone 1.5.24 min de leituraAtualizado a

Onde fica a API

O resource chama-se phone, por isso todas as chamadas são exports.phone:.... Espere que o telemóvel esteja pronto antes de o usar: IsReady() passa a true quando a base de dados responde e o telemóvel aceita pedidos.

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

phone_api na consola do servidor imprime um resumo curto da API de apps.

Exports de servidor mais usados

Export O que faz
GetPhoneNumber(src) o número do telemóvel que o jogador tem, ou nil até ele carregar
SourceOfNumber(number) o jogador online com esse número, ou nil
Notify(src, { title, body, app?, actions? }) uma notificação no telemóvel desse jogador, com até 3 botões
SendMessage(src, number, text) uma mensagem desse jogador para um número
SendMail(address, sender, subject, body) um e-mail para um endereço
Call(src, number, video?) faz uma chamada para esse jogador
SetPhoneDisabled(src, bool) desliga ou liga o telemóvel de um jogador (uma prisão, uma cutscene)
RecordTransaction(number, 'sent' or 'received', amount, party, note?) uma linha de extrato na Wallet; não movimenta dinheiro

Os scripts escritos para outro telemóvel chamam estes em vez dos exports desse telemóvel:

Export O que faz
ResolvePhone(target[, cb]) encontra um telemóvel por { source }, { number }, { email }, { identifier } ou { imei }
DeliverMailTo(target, mail[, cb]) e-mail para esse telemóvel: { sender, subject, body }
SendText(from, to, body[, opts][, cb]) uma mensagem de um telemóvel, ou de um serviço com nome
DispatchAlert(jobs, { title, body, coords? }) um alerta para todos os membros em serviço desses empregos; devolve quantos foram alcançados

Exemplo: um script de assalto alerta a polícia com um marcador no mapa.

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

Eventos de servidor

Escute com AddEventHandler num script de servidor. Só o telemóvel os dispara; um cliente não os consegue falsificar.

Evento Argumentos
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: foi premido um botão oferecido pelo seu Notify

Exports de cliente

Export O que faz
Open(), Close(), IsOpen() abre ou fecha o telemóvel; Open respeita todos os bloqueios abaixo
AddOpenCheck(fn) fn() a devolver false impede o telemóvel de abrir; é removido quando o seu resource pára
SetRestriction(key, mode) um estado de jogador seu: 'block', 'emergency-only' ou nil para o limpar
SetCarAudio(state) mostra o seu rádio de carro no Pulse Drive, o ecrã do carro
GetPhoneNumber(), IsInCall(), GetBattery() o telemóvel deste jogador

Exemplo: sem telemóvel enquanto o jogador está na sua prisão.

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

Bolsas de estado (state bags)

O servidor grava-os em Player(src).state, com os nomes que outros resources de telemóvel usam, para que os scripts de HUD e de despacho os leiam sem alterações: phoneNumber, phoneOpen, inCall, onCallWith, phoneBattery, phoneDead. Os clientes leem os seus como LocalPlayer.state.phoneOpen.

Exemplos de configuração

As definições do telemóvel ficam em phone/config/. Três de que outros scripts dependem:

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
}

As suas próprias apps

exports.phone:RegisterApp({ id, name, colour, icon, page = { kind = 'frame', url = 'ui/index.html' } }) adiciona uma app ao ecrã inicial e à App Hub. A página corre numa frame própria e fala com o seu servidor através do telemóvel. As permissões, notificações, idiomas e a listagem na App Hub são campos opcionais. O guia completo é Apps personalizadas.

Notas de integração

  • O Pulse Phone responde sozinho aos nomes de evento do lb-phone, qb-phone e NPWD, por isso os scripts que enviam e-mails, mensagens e alertas dessa forma continuam a funcionar. Os scripts que chamam os exports de outro telemóvel precisam de uma alteração: exports.phone. Veja Mudar de telemóvel.
  • Passe o source real a partir dos seus próprios eventos de servidor. Nunca tire o id de um jogador de uma mensagem do cliente.
  • Banco, garagens, habitação e despacho são ligados através das pontes do telemóvel, escolhidas no arranque. O seu próprio script pode ser adicionado como fornecedor: Integrações avançadas.

Perguntas frequentes

Como se chama o resource do Pulse Phone?

phone. Todos os exports são exports.phone:Name(...). Mantenha o nome da pasta, porque os outros scripts e os hooks de item do inventário o chamam por esse nome.

Os scripts feitos para o lb-phone ou qb-phone funcionam com o Pulse Phone?

Os scripts que usam os eventos desses telemóveis (e-mail, mensagens, notificações, número de telefone) funcionam sem edições. Os scripts que chamam os exports deles precisam de exports.phone.

Posso adicionar uma app minha ao Pulse Phone?

Sim. Registe-a com RegisterApp a partir do seu resource. Aparece na App Hub, e o guia cobre páginas, permissões e notificações.

Traduzido do inglês. Se alguma coisa aqui não coincidir com a página em inglês, vale a página em inglês. English