ai-voice para desenvolvedores

O ai-voice responde ao pma-voice 7.x: todo export abaixo que o pma-voice tem também responde em exports['pma-voice']. O servidor é dono de todo o estado de voz (alcance, frequências, chamadas, alto-falantes, silenciamentos) e escreve os state bags do jogador; os clientes só pedem. Nenhum dos exports espera. Eles não são tipados em @aicore-fivem/shared: a partir do TypeScript use o callExport("ai-voice", name, ...args) da lib.

Exports do servidorCopy Anchor Link

setPlayerRadioCopy Anchor Link

Coloca um jogador em uma frequência de rádio e a torna a ativa dele (aquela em que ele fala). Nome do pma-voice.

Lado: Servidor · Espera: não

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

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

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

Nada. Lança um erro quando channel não é um número. Não faz nada quando o rádio está desligado no painel. Uma frequência em que o jogador não pode entrar (uma frequência de emprego, ou um addChannelCheck que diz não) é recusada com a notificação "You cannot join this frequency". Entrar em uma nova frequência sai da ativa anterior; as frequências que o jogador só escuta continuam.

setPlayerCallCopy Anchor Link

Coloca um jogador em uma chamada telefônica, ou o tira dela. Nome do pma-voice.

Lado: Servidor · Espera: não

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

ExemploCopy 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

Os membros de uma frequência. Também responde como GetPlayersInRadioChannel. Nome do pma-voice.

Lado: Servidor · Espera: não

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

RetornoCopy Anchor Link

Uma tabela indexada pelo id do servidor (como string) com true enquanto aquele membro está falando, senão false. {} para uma frequência vazia ou um valor inválido.

addChannelCheckCopy Anchor Link

Adiciona uma regra sua para uma frequência: sua função decide quem pode entrar. Removida quando seu recurso para. Nome do pma-voice.

Lado: Servidor · Espera: não

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

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

As regras de frequência do painel são verificadas primeiro; depois sua função precisa responder um valor verdadeiro. Lança um erro quando check não é uma função.

overrideRadioNameGetterCopy Anchor Link

Substitui o nome que os membros do rádio veem uns dos outros (quando Send names to radio members está ligado). Nome do pma-voice.

Lado: Servidor · Espera: não

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

O primeiro argumento é ignorado (compatibilidade com o pma-voice); o getter é usado para toda frequência.

isValidPlayerCopy Anchor Link

isValidPlayer(source: number): boolean

true quando o ai-voice conhece o jogador (entrou e foi configurado).

setPlayerProximityModeCopy Anchor Link

Muda um jogador para um dos alcances do painel.

Lado: Servidor · Espera: não

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

RetornoCopy Anchor Link

boolean: true quando mudou. false quando o jogador é desconhecido, index está fora da lista, ou um addProximityCheck recusou.

setPlayerRangeCopy Anchor Link

Dá a um jogador um alcance seu (um megafone, um microfone em um palco), ou devolve o alcance que ele escolheu.

Lado: Servidor · Espera: não

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

RetornoCopy Anchor Link

boolean: true quando definido. false quando o jogador é desconhecido, metres está fora de 0.5-100, ou um addProximityCheck recusou.

ExemploCopy Anchor Link

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

// Um item megafone: 30 m enquanto está na mão.
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

O alcance atual do jogador: index (posição na lista), distance em metros, mode (o nome do alcance). null para um jogador desconhecido.

toggleMuteCopy Anchor Link

Silencia um jogador, ou tira o silêncio de um silenciado. O mesmo que /muteply.

Lado: Servidor · Espera: não

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

RetornoCopy Anchor Link

boolean: true quando o silêncio foi alternado, false para um jogador desconhecido. O jogador recebe uma notificação; o evento de servidor pma-voice:playerMuted dispara. Os silenciamentos são guardados por license, então sobrevivem a uma reconexão.

addProximityCheckCopy Anchor Link

Adiciona uma regra para mudanças de alcance. Sua função recebe (source, index, distance); responder false recusa a mudança (tanto a tecla do jogador quanto os exports). Removida quando seu recurso para.

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

Várias frequênciasCopy Anchor Link

Extras de telefoneCopy Anchor Link

OutrosCopy Anchor Link

Exports do clienteCopy Anchor Link

Os exports do cliente do pma-voice (todos também em exports['pma-voice']):

Os próprios exports do cliente do ai-voice:

State bagsCopy Anchor Link

Escritos pelo servidor em cada jogador (Player(source).state, no cliente LocalPlayer.state). Leia-os; nunca os escreva.

GlobalState: ai-voice:backend ("mumble" ou "enhanced"), ai-voice:takeover (scripts que trazem seu próprio efeito de rádio ou de celular). O ai-voice lê o bag dead do AI Core e o bag isDead do pma-voice.

EventosCopy Anchor Link

Os eventos de rede do pma-voice (pma-voice:syncRadioData, addPlayerToRadio, removePlayerFromRadio, setTalkingOnRadio, clSetPlayerRadio, syncCallData, addPlayerToCall, removePlayerFromCall, clSetPlayerCall) mantêm seus nomes e payloads para UIs de rádio que os escutam. Os eventos de rádio carregam a frequência como um último argumento extra; as tabelas de membros têm chaves string.

// Cliente: mostra um ícone "no ar" enquanto o jogador fala no rádio.
on("pma-voice:radioActive", (talking: boolean) => {
  SendNUIMessage({ action: "radio", data: talking });
});