ai-voice pour les développeurs

ai-voice répond à pma-voice 7.x : chaque export ci-dessous que pma-voice possède répond aussi sous exports['pma-voice']. Le serveur détient tout l’état vocal (portée, fréquences, appels, haut-parleurs, sourdines) et écrit les state bags des joueurs ; les clients ne font que demander. Aucun export n’attend. Ils ne sont pas typés dans @aicore-fivem/shared : depuis TypeScript, utilisez callExport("ai-voice", name, ...args) de la lib.

Exports serveurCopy Anchor Link

setPlayerRadioCopy Anchor Link

Place un joueur sur une fréquence radio et en fait sa fréquence active (celle sur laquelle il parle). Nom de pma-voice.

Côté : serveur · Attend : non

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

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

ParamètresCopy Anchor Link

RetourCopy Anchor Link

Rien. Lève une erreur quand channel n’est pas un nombre. Ne fait rien quand la radio est désactivée dans le panneau. Une fréquence que le joueur ne peut pas rejoindre (une fréquence de métier, ou un addChannelCheck qui dit non) est refusée avec la notification « You cannot join this frequency ». Rejoindre une nouvelle fréquence quitte la précédente fréquence active ; les fréquences que le joueur ne fait qu’écouter restent.

setPlayerCallCopy Anchor Link

Place un joueur dans un appel téléphonique, ou l’en retire. Nom de pma-voice.

Côté : serveur · Attend : non

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

ExempleCopy Anchor Link

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

let nextCall = 1000;

/** Connecte deux joueurs ; renvoie l’id de l’appel pour y mettre fin plus tard. */
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

Les membres d’une fréquence. Répond aussi en tant que GetPlayersInRadioChannel. Nom de pma-voice.

Côté : serveur · Attend : non

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

RetourCopy Anchor Link

Une table indexée par id serveur (sous forme de chaîne) avec true tant que ce membre parle, sinon false. {} pour une fréquence vide ou une valeur incorrecte.

addChannelCheckCopy Anchor Link

Ajoute votre propre règle pour une fréquence : votre fonction décide qui peut la rejoindre. Retirée quand votre ressource s’arrête. Nom de pma-voice.

Côté : serveur · Attend : non

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

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

Les règles de fréquences du panneau sont vérifiées d’abord ; ensuite votre fonction doit répondre une valeur vraie. Lève une erreur quand check n’est pas une fonction.

overrideRadioNameGetterCopy Anchor Link

Remplace le nom que les membres de la radio voient les uns des autres (quand Send names to radio members est activé). Nom de pma-voice.

Côté : serveur · Attend : non

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

Le premier argument est ignoré (compatibilité pma-voice) ; le getter est utilisé pour chaque fréquence.

isValidPlayerCopy Anchor Link

isValidPlayer(source: number): boolean

true quand ai-voice connaît le joueur (connecté et configuré).

setPlayerProximityModeCopy Anchor Link

Fait passer un joueur à l’une des portées du panneau.

Côté : serveur · Attend : non

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

RetourCopy Anchor Link

boolean : true quand la portée a changé. false quand le joueur est inconnu, que index est hors de la liste, ou qu’un addProximityCheck l’a refusé.

setPlayerRangeCopy Anchor Link

Donne à un joueur une portée de votre choix (un mégaphone, un micro sur une scène), ou lui rend la portée qu’il avait choisie.

Côté : serveur · Attend : non

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

RetourCopy Anchor Link

boolean : true quand la portée a été réglée. false quand le joueur est inconnu, que metres est hors de 0,5-100, ou qu’un addProximityCheck l’a refusé.

ExempleCopy Anchor Link

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

// Un objet mégaphone : 30 m tant qu’il est tenu.
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

La portée actuelle du joueur : index (position dans la liste), distance en mètres, mode (le nom de la portée). null pour un joueur inconnu.

toggleMuteCopy Anchor Link

Rend un joueur muet, ou rétablit la voix d’un joueur muet. Comme /muteply.

Côté : serveur · Attend : non

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

RetourCopy Anchor Link

boolean : true quand la sourdine a été basculée, false pour un joueur inconnu. Le joueur reçoit une notification ; l’event serveur pma-voice:playerMuted se déclenche. Les sourdines sont conservées par licence, donc elles survivent à une reconnexion.

addProximityCheckCopy Anchor Link

Ajoute une règle pour les changements de portée. Votre fonction reçoit (source, index, distance) ; répondre false refuse le changement (aussi bien la touche du joueur que les exports). Retirée quand votre ressource s’arrête.

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

Plusieurs fréquencesCopy Anchor Link

Extras téléphoneCopy Anchor Link

AutresCopy Anchor Link

Exports clientCopy Anchor Link

Les exports client de pma-voice (tous aussi sous exports['pma-voice']) :

Les exports client propres à ai-voice :

State bagsCopy Anchor Link

Écrits par le serveur sur chaque joueur (Player(source).state, côté client LocalPlayer.state). Lisez-les ; ne les écrivez jamais.

GlobalState : ai-voice:backend ("mumble" ou "enhanced"), ai-voice:takeover (les scripts qui apportent leur propre effet de radio ou de téléphone). ai-voice lit le bag dead d’AI Core et le bag isDead de pma-voice.

EventsCopy Anchor Link

Les net events de pma-voice (pma-voice:syncRadioData, addPlayerToRadio, removePlayerFromRadio, setTalkingOnRadio, clSetPlayerRadio, syncCallData, addPlayerToCall, removePlayerFromCall, clSetPlayerCall) gardent leurs noms et leurs contenus pour les interfaces radio qui les écoutent. Les events radio transportent la fréquence comme dernier argument supplémentaire ; les tables de membres ont des clés de type chaîne.

// Client : afficher une icône « à l’antenne » tant que le joueur parle à la radio.
on("pma-voice:radioActive", (talking: boolean) => {
  SendNUIMessage({ action: "radio", data: talking });
});