Documentación de Pulse Phone
API para desarrolladores de Pulse Phone
Pulse Phone ofrece a otros resources una API de servidor y de cliente: leer el número de un jugador, enviar mensajes, correo y notificaciones, hacer llamadas, reaccionar a lo que pasa en el teléfono y añadir apps propias. Todo lo de esta página sale del resource phone de Pulse Phone 1.5.0. La lista completa, con todos los argumentos, está en Exports y eventos.
Dónde está la API
El resource se llama phone, así que cada llamada es exports.phone:.... Espera al teléfono antes de usarlo: IsReady() pasa a true cuando la base de datos responde y el teléfono acepta peticiones.
CreateThread(function()
while GetResourceState('phone') ~= 'started' or not exports.phone:IsReady() do Wait(500) end
print('Pulse Phone is ready')
end)phone_api en la consola del servidor imprime un breve resumen de la API de apps.
Exports de servidor más usados
| Export | Qué hace |
|---|---|
GetPhoneNumber(src) |
el número del teléfono que tiene el jugador, o nil hasta que se haya cargado |
SourceOfNumber(number) |
el jugador conectado con ese número, o nil |
Notify(src, { title, body, app?, actions? }) |
una notificación en el teléfono de ese jugador, con hasta 3 botones |
SendMessage(src, number, text) |
un mensaje de texto de ese jugador a un número |
SendMail(address, sender, subject, body) |
un correo a una dirección |
Call(src, number, video?) |
hace una llamada para ese jugador |
SetPhoneDisabled(src, bool) |
apaga o enciende el teléfono de un jugador (una cárcel, una cinemática) |
RecordTransaction(number, 'sent' or 'received', amount, party, note?) |
una línea de movimientos en Cartera; no mueve dinero |
Los scripts escritos para otro teléfono llaman a estos en lugar de a los exports de ese teléfono:
| Export | Qué hace |
|---|---|
ResolvePhone(target[, cb]) |
encuentra un teléfono por { source }, { number }, { email }, { identifier } o { imei } |
DeliverMailTo(target, mail[, cb]) |
correo a ese teléfono: { sender, subject, body } |
SendText(from, to, body[, opts][, cb]) |
un mensaje de texto desde un teléfono, o desde un servicio con nombre |
DispatchAlert(jobs, { title, body, coords? }) |
un aviso a todos los miembros de esos trabajos que estén de servicio; devuelve a cuántos llegó |
Ejemplo: un script de atraco avisa a la policía con una marca en el 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
Escucha con AddEventHandler en un script de servidor. Solo los lanza el teléfono; un cliente no puede falsificarlos.
| 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: se pulsó un botón que ofrecía tu Notify |
Exports de cliente
| Export | Qué hace |
|---|---|
Open(), Close(), IsOpen() |
abre o cierra el teléfono; Open respeta todos los bloqueos de abajo |
AddOpenCheck(fn) |
fn() que devuelve false impide que el teléfono se abra; se quita cuando tu resource se detiene |
SetRestriction(key, mode) |
un estado de jugador propio: 'block', 'emergency-only' o nil para quitarlo |
SetCarAudio(state) |
muestra el equipo de tu coche en Pulse Drive, la pantalla del coche |
GetPhoneNumber(), IsInCall(), GetBattery() |
el teléfono propio de este jugador |
Ejemplo: sin teléfono mientras un jugador está en tu cárcel.
exports.phone:SetRestriction('myjail', 'block') -- on entering the cell
exports.phone:SetRestriction('myjail', nil) -- on releaseEstados compartidos (state bags)
El servidor los escribe en Player(src).state, con los nombres que usan otros resources de teléfono, para que los scripts de HUD y despacho los lean sin cambios: phoneNumber, phoneOpen, inCall, onCallWith, phoneBattery, phoneDead. Los clientes leen los suyos como LocalPlayer.state.phoneOpen.
Ejemplos de configuración
Los ajustes del teléfono están en phone/config/. Tres de los que dependen otros scripts:
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
}Tus propias apps
exports.phone:RegisterApp({ id, name, colour, icon, page = { kind = 'frame', url = 'ui/index.html' } }) añade una app a la pantalla de inicio y al App Hub. La página se ejecuta en su propio frame y habla con tu servidor a través del teléfono. Los permisos, las notificaciones, los idiomas y la ficha del App Hub son campos opcionales. La guía completa es Apps personalizadas.
Notas de integración
- Pulse Phone responde por sí solo a los nombres de evento de lb-phone, qb-phone y NPWD, así que los scripts que envían correo, mensajes y avisos de ese modo siguen funcionando. Los scripts que llaman a los exports de otro teléfono necesitan un cambio:
exports.phone. Consulta Cambiar de teléfono. - Pasa el
sourcereal desde tus propios eventos de servidor. Nunca tomes el id de un jugador de un mensaje del cliente. - El banco, los garajes, la vivienda y el despacho se conectan mediante los puentes del teléfono, que se eligen al arrancar. Tu propio script puede añadirse como proveedor: Integraciones avanzadas.
Preguntas frecuentes
¿Cómo se llama el resource de Pulse Phone?
phone. Cada export es exports.phone:Name(...). Mantén el nombre de la carpeta, porque otros scripts y los hooks de los items del inventario lo llaman con ese nombre.
¿Los scripts hechos para lb-phone o qb-phone funcionan con Pulse Phone?
Los scripts que usan los eventos de esos teléfonos (correo, mensajes, notificaciones, número de teléfono) funcionan sin cambios. Los scripts que llaman a sus exports necesitan exports.phone en su lugar.
¿Puedo añadir mi propia app a Pulse Phone?
Sí. Regístrala con RegisterApp desde tu resource. Aparece en el App Hub, y la guía cubre páginas, permisos y notificaciones.