Documentação do Pulse Phone
API para desenvolvedores 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 celular e adicionar apps próprios. 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.
Onde fica a API
O resource se chama phone, então toda chamada é exports.phone:.... Espere o celular ficar pronto antes de usá-lo: IsReady() passa a ser true quando o banco de dados responde e o celular aceita requisições.
CreateThread(function()
while GetResourceState('phone') ~= 'started' or not exports.phone:IsReady() do Wait(500) end
print('Pulse Phone is ready')
end)phone_api no console 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 celular 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 celular 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 celular 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 |
Scripts escritos para outro celular chamam estes no lugar dos exports desse celular:
| Export | O que faz |
|---|---|
ResolvePhone(target[, cb]) |
encontra um celular por { source }, { number }, { email }, { identifier } ou { imei } |
DeliverMailTo(target, mail[, cb]) |
e-mail para esse celular: { sender, subject, body } |
SendText(from, to, body[, opts][, cb]) |
uma mensagem de um celular, ou de um serviço com nome |
DispatchAlert(jobs, { title, body, coords? }) |
um alerta para todos os membros em serviço desses empregos; retorna quantos foram alcançados |
Exemplo: um script de assalto alerta a polícia com um marcador no mapa.
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 em um script de servidor. Só o celular os dispara; um cliente não consegue falsificá-los.
| 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: um botão oferecido pelo seu Notify foi pressionado |
Exports de cliente
| Export | O que faz |
|---|---|
Open(), Close(), IsOpen() |
abre ou fecha o celular; Open respeita todos os bloqueios abaixo |
AddOpenCheck(fn) |
fn() retornando false impede o celular de abrir; é removido quando o seu resource para |
SetRestriction(key, mode) |
um estado de jogador seu: 'block', 'emergency-only' ou nil para limpar |
SetCarAudio(state) |
mostra o seu rádio de carro no Pulse Drive, a tela do carro |
GetPhoneNumber(), IsInCall(), GetBattery() |
o celular deste jogador |
Exemplo: sem celular enquanto o jogador está na sua prisão.
exports.phone:SetRestriction('myjail', 'block') -- on entering the cell
exports.phone:SetRestriction('myjail', nil) -- on releaseBolsas de estado (state bags)
O servidor grava estes em Player(src).state, com os nomes que outros resources de celular usam, para que scripts de HUD e de despacho os leiam sem mudanças: phoneNumber, phoneOpen, inCall, onCallWith, phoneBattery, phoneDead. Os clientes leem os seus como LocalPlayer.state.phoneOpen.
Exemplos de configuração
As configurações do celular ficam em phone/config/. Três de que outros scripts dependem:
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
}Seus próprios apps
exports.phone:RegisterApp({ id, name, colour, icon, page = { kind = 'frame', url = 'ui/index.html' } }) adiciona um app à tela inicial e à App Hub. A página roda em um frame próprio e conversa com o seu servidor pelo celular. Permissões, notificações, idiomas e a listagem na App Hub são campos opcionais. O guia completo é Apps personalizados.
Notas de integração
- O Pulse Phone responde sozinho aos nomes de evento do lb-phone, qb-phone e NPWD, então scripts que enviam e-mails, mensagens e alertas dessa forma continuam funcionando. Scripts que chamam os exports de outro celular precisam de uma mudança:
exports.phone. Veja Trocando de celular. - Passe o
sourcereal a partir dos seus próprios eventos de servidor. Nunca pegue o id de um jogador de uma mensagem do cliente. - Banco, garagens, moradia e despacho são conectados pelas pontes do celular, escolhidas na inicialização. O seu próprio script pode ser adicionado como provedor: Integrações avançadas.
Perguntas frequentes
Como se chama o resource do Pulse Phone?
phone. Todo export é exports.phone:Name(...). Mantenha o nome da pasta, porque outros scripts e os hooks de item do inventário o chamam por esse nome.
Scripts feitos para o lb-phone ou qb-phone funcionam com o Pulse Phone?
Scripts que usam os eventos desses celulares (e-mail, mensagens, notificações, número de telefone) funcionam sem edição. Scripts que chamam os exports deles precisam de exports.phone.
Posso adicionar um app meu ao Pulse Phone?
Sim. Registre-o com RegisterApp a partir do seu resource. Ele aparece na App Hub, e o guia cobre páginas, permissões e notificações.