ai-voice für Entwickler

ai-voice beantwortet pma-voice 7.x: Jeder Export unten, den pma-voice hat, antwortet auch unter exports['pma-voice']. Der Server besitzt den gesamten Sprachstatus (Reichweite, Frequenzen, Anrufe, Lautsprecher, Stummschaltungen) und schreibt die Spieler-State-Bags; Clients fragen nur an. Keiner der Exports wartet. Sie sind nicht in @aicore-fivem/shared typisiert: Aus TypeScript nutzt du callExport("ai-voice", name, ...args) der Lib.

Server-ExportsCopy Anchor Link

setPlayerRadioCopy Anchor Link

Setzt einen Spieler auf eine Funkfrequenz und macht sie zu seiner aktiven (der, auf der er spricht). Name von pma-voice.

Seite: Server · Wartet: nein

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

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

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

Nichts. Wirft einen Fehler, wenn channel keine Zahl ist. Tut nichts, wenn der Funk im Panel aus ist. Eine Frequenz, der der Spieler nicht beitreten darf (eine Job-Frequenz oder ein addChannelCheck, der nein sagt), wird mit der Benachrichtigung „You cannot join this frequency“ abgelehnt. Der Beitritt zu einer neuen Frequenz verlässt die vorherige aktive; Frequenzen, die der Spieler nur hört, bleiben.

setPlayerCallCopy Anchor Link

Setzt einen Spieler in ein Telefonat oder nimmt ihn heraus. Name von pma-voice.

Seite: Server · Wartet: nein

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

BeispielCopy Anchor Link

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

let nextCall = 1000;

/** Verbindet zwei Spieler; gibt die Anruf-ID zurück, um ihn später zu beenden. */
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

Die Mitglieder einer Frequenz. Antwortet auch als GetPlayersInRadioChannel. Name von pma-voice.

Seite: Server · Wartet: nein

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

RückgabewertCopy Anchor Link

Eine Tabelle mit der Server-ID (als String) als Schlüssel und true, solange dieses Mitglied spricht, sonst false. {} für eine leere Frequenz oder einen ungültigen Wert.

addChannelCheckCopy Anchor Link

Fügt eine eigene Regel für eine Frequenz hinzu: Deine Funktion entscheidet, wer beitreten darf. Wird entfernt, wenn deine Ressource stoppt. Name von pma-voice.

Seite: Server · Wartet: nein

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

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

Die Frequenzregeln des Panels werden zuerst geprüft; danach muss deine Funktion einen wahren Wert liefern. Wirft einen Fehler, wenn check keine Funktion ist.

overrideRadioNameGetterCopy Anchor Link

Ersetzt den Namen, den Funkmitglieder voneinander sehen (wenn Send names to radio members an ist). Name von pma-voice.

Seite: Server · Wartet: nein

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

Das erste Argument wird ignoriert (Kompatibilität mit pma-voice); der Getter wird für jede Frequenz genutzt.

isValidPlayerCopy Anchor Link

isValidPlayer(source: number): boolean

true, wenn ai-voice den Spieler kennt (beigetreten und eingerichtet).

setPlayerProximityModeCopy Anchor Link

Wechselt einen Spieler auf eine der Reichweiten des Panels.

Seite: Server · Wartet: nein

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

RückgabewertCopy Anchor Link

boolean: true, wenn gewechselt. false, wenn der Spieler unbekannt ist, index außerhalb der Liste liegt oder ein addProximityCheck es abgelehnt hat.

setPlayerRangeCopy Anchor Link

Gibt einem Spieler eine eigene Reichweite (ein Megafon, ein Mikrofon auf einer Bühne) oder gibt ihm seine gewählte Reichweite zurück.

Seite: Server · Wartet: nein

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

RückgabewertCopy Anchor Link

boolean: true, wenn gesetzt. false, wenn der Spieler unbekannt ist, metres außerhalb von 0.5-100 liegt oder ein addProximityCheck es abgelehnt hat.

BeispielCopy Anchor Link

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

// Ein Megafon-Item: 30 m, solange es gehalten wird.
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

Die aktuelle Reichweite des Spielers: index (Position in der Liste), distance in Metern, mode (der Name der Reichweite). null für einen unbekannten Spieler.

toggleMuteCopy Anchor Link

Schaltet einen Spieler stumm oder hebt die Stummschaltung eines stummen Spielers auf. Dasselbe wie /muteply.

Seite: Server · Wartet: nein

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

RückgabewertCopy Anchor Link

boolean: true, wenn die Stummschaltung umgeschaltet wurde, false für einen unbekannten Spieler. Der Spieler bekommt eine Benachrichtigung; das Server-Event pma-voice:playerMuted wird ausgelöst. Stummschaltungen werden per License gespeichert, daher überstehen sie ein erneutes Verbinden.

addProximityCheckCopy Anchor Link

Fügt eine Regel für Reichweitenänderungen hinzu. Deine Funktion bekommt (source, index, distance); die Antwort false lehnt die Änderung ab (sowohl die Taste des Spielers als auch die Exports). Wird entfernt, wenn deine Ressource stoppt.

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

Mehrere FrequenzenCopy Anchor Link

Telefon-ExtrasCopy Anchor Link

SonstigeCopy Anchor Link

Client-ExportsCopy Anchor Link

Die Client-Exports von pma-voice (alle auch unter exports['pma-voice']):

Die eigenen Client-Exports von ai-voice:

State BagsCopy Anchor Link

Vom Server an jedem Spieler geschrieben (Player(source).state, Client LocalPlayer.state). Lies sie; schreibe sie nie.

GlobalState: ai-voice:backend ("mumble" oder "enhanced"), ai-voice:takeover (Skripte, die ihren eigenen Funk- oder Telefoneffekt mitbringen). ai-voice liest den Bag dead von AI Core und den Bag isDead von pma-voice.

EventsCopy Anchor Link

Die Net-Events von pma-voice (pma-voice:syncRadioData, addPlayerToRadio, removePlayerFromRadio, setTalkingOnRadio, clSetPlayerRadio, syncCallData, addPlayerToCall, removePlayerFromCall, clSetPlayerCall) behalten ihre Namen und Payloads für Funk-UIs, die darauf hören. Funk-Events tragen die Frequenz als zusätzliches letztes Argument; Mitgliedertabellen haben String-Schlüssel.

// Client: ein „On Air“-Symbol zeigen, während der Spieler über Funk spricht.
on("pma-voice:radioActive", (talking: boolean) => {
  SendNUIMessage({ action: "radio", data: talking });
});