ai-voice para desarrolladores

ai-voice responde a pma-voice 7.x: cada export de abajo que tiene pma-voice también responde bajo exports['pma-voice']. El servidor es dueño de todo el estado de voz (alcance, frecuencias, llamadas, altavoces, silencios) y escribe los state bags del jugador; los clientes solo piden. Ninguno de los exports espera. No están tipados en @aicore-fivem/shared: desde TypeScript usa callExport("ai-voice", name, ...args) de la lib.

Exports de servidorCopy Anchor Link

setPlayerRadioCopy Anchor Link

Pone a un jugador en una frecuencia de radio y la hace su frecuencia activa (en la que habla). Nombre de pma-voice.

Lado: Servidor · Espera: no

setPlayerRadio(source: number, channel: number | string): void

exports['pma-voice']:setPlayerRadio(source, 5)

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

Nada. Lanza un error cuando channel no es un número. No hace nada cuando la radio está desactivada en el panel. Una frecuencia a la que el jugador no puede unirse (una frecuencia de trabajo, o un addChannelCheck que dice que no) se rechaza con una notificación "You cannot join this frequency". Unirse a una frecuencia nueva abandona la activa anterior; las frecuencias que el jugador solo escucha se quedan.

setPlayerCallCopy Anchor Link

Mete a un jugador en una llamada telefónica, o lo saca. Nombre de pma-voice.

Lado: Servidor · Espera: no

setPlayerCall(source: number, callId: number | string): void

EjemploCopy Anchor Link

import { callExport } from "@aicore-fivem/lib/server";

let nextCall = 1000;

/** Connects two players; returns the call id to end it later. */
export function connect(caller: number, target: number): number {
  const id = nextCall++;
  callExport("ai-voice", "setPlayerCall", caller, id);
  callExport("ai-voice", "setPlayerCall", target, id);
  return id;
}

export function hangUp(...players: number[]): void {
  for (const p of players) callExport("ai-voice", "setPlayerCall", p, 0);
}

getPlayersInRadioChannelCopy Anchor Link

Los miembros de una frecuencia. También responde como GetPlayersInRadioChannel. Nombre de pma-voice.

Lado: Servidor · Espera: no

getPlayersInRadioChannel(channel: number | string): Record<string, boolean>

DevuelveCopy Anchor Link

Una tabla con el id de servidor (como string) como clave y true mientras ese miembro habla, si no false. {} para una frecuencia vacía o un valor incorrecto.

addChannelCheckCopy Anchor Link

Añade tu propia regla para una frecuencia: tu función decide quién puede unirse. Se quita cuando tu recurso se detiene. Nombre de pma-voice.

Lado: Servidor · Espera: no

addChannelCheck(channel: number, check: (source: number) => boolean): void

exports['pma-voice']:addChannelCheck(911, function(source)
    return exports['ai-core']:GetDutyJob(source) == 'ambulance'
end)

Primero se comprueban las reglas de frecuencias del panel; después tu función debe responder un valor verdadero. Lanza un error cuando check no es una función.

overrideRadioNameGetterCopy Anchor Link

Reemplaza el nombre que ven entre sí los miembros de la radio (cuando Send names to radio members está activado). Nombre de pma-voice.

Lado: Servidor · Espera: no

overrideRadioNameGetter(channel: unknown, getter: (source: number) => string): void

El primer argumento se ignora (compatibilidad con pma-voice); el getter se usa para todas las frecuencias.

isValidPlayerCopy Anchor Link

isValidPlayer(source: number): boolean

true cuando ai-voice conoce al jugador (se ha unido y está configurado).

setPlayerProximityModeCopy Anchor Link

Cambia a un jugador a uno de los alcances del panel.

Lado: Servidor · Espera: no

setPlayerProximityMode(source: number, index: number): boolean

DevuelveCopy Anchor Link

boolean: true cuando se cambió. false cuando el jugador es desconocido, index está fuera de la lista o un addProximityCheck lo rechazó.

setPlayerRangeCopy Anchor Link

Da a un jugador un alcance propio (un megáfono, un micrófono en un escenario), o le devuelve el alcance que eligió.

Lado: Servidor · Espera: no

setPlayerRange(source: number, metres: number | null): boolean

DevuelveCopy Anchor Link

boolean: true cuando se fijó. false cuando el jugador es desconocido, metres está fuera de 0.5-100 o un addProximityCheck lo rechazó.

EjemploCopy Anchor Link

import { callExport, onClientEvent } from "@aicore-fivem/lib/server";

// Un objeto megáfono: 30 m mientras se sostiene.
onClientEvent("myscript:megaphone", { args: ([on]) => (typeof on === "boolean" ? [on] : null) }, (source, on) => {
  callExport("ai-voice", "setPlayerRange", source, on ? 30 : null);
});

getPlayerProximityCopy Anchor Link

getPlayerProximity(source: number): { index: number; distance: number; mode: string } | null

El alcance actual del jugador: index (posición en la lista), distance en metros, mode (el nombre del alcance). null para un jugador desconocido.

toggleMuteCopy Anchor Link

Silencia a un jugador, o quita el silencio a uno silenciado. Lo mismo que /muteply.

Lado: Servidor · Espera: no

toggleMute(source: number, seconds?: number): boolean

DevuelveCopy Anchor Link

boolean: true cuando se cambió el silencio, false para un jugador desconocido. El jugador recibe una notificación; se dispara el evento de servidor pma-voice:playerMuted. Los silencios se guardan por licencia, así que se mantienen al reconectarse.

addProximityCheckCopy Anchor Link

Añade una regla para los cambios de alcance. Tu función recibe (source, index, distance); responder false rechaza el cambio (tanto la tecla del jugador como los exports). Se quita cuando tu recurso se detiene.

addProximityCheck(check: (source: number, index: number, distance: number) => boolean | void): void

Varias frecuenciasCopy Anchor Link

Extras de teléfonoCopy Anchor Link

OtrosCopy Anchor Link

Exports de clienteCopy Anchor Link

Los exports de cliente de pma-voice (todos también bajo exports['pma-voice']):

Los exports de cliente propios de ai-voice:

State bagsCopy Anchor Link

Los escribe el servidor en cada jugador (Player(source).state, en el cliente LocalPlayer.state). Léelos; nunca los escribas.

GlobalState: ai-voice:backend ("mumble" o "enhanced"), ai-voice:takeover (scripts que traen su propio efecto de radio o teléfono). ai-voice lee el bag dead de AI Core y el bag isDead de pma-voice.

EventosCopy Anchor Link

Los eventos de red de pma-voice (pma-voice:syncRadioData, addPlayerToRadio, removePlayerFromRadio, setTalkingOnRadio, clSetPlayerRadio, syncCallData, addPlayerToCall, removePlayerFromCall, clSetPlayerCall) conservan sus nombres y payloads para las interfaces de radio que los escuchan. Los eventos de radio llevan la frecuencia como último argumento extra; las tablas de miembros tienen claves string.

// Cliente: mostrar un icono "en el aire" mientras el jugador habla por la radio.
on("pma-voice:radioActive", (talking: boolean) => {
  SendNUIMessage({ action: "radio", data: talking });
});