ai-voice для разработчиков

ai-voice отвечает как pma-voice 7.x: каждый экспорт ниже, который есть в pma-voice, отвечает также под exports['pma-voice']. Всё состояние голоса (дальность, частоты, звонки, громкая связь, заглушения) принадлежит серверу, и он пишет state bags игрока; клиенты только просят. Ни один экспорт не ждёт. Они не типизированы в @aicore-fivem/shared: из TypeScript используйте callExport("ai-voice", name, ...args) из lib.

Серверные экспортыCopy Anchor Link

setPlayerRadioCopy Anchor Link

Помещает игрока на радиочастоту и делает её активной (той, на которой он говорит). Имя из pma-voice.

Сторона: сервер · Ожидание: нет

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

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

ПараметрыCopy Anchor Link

ВозвращаетCopy Anchor Link

Ничего. Выбрасывает ошибку, если channel не число. Ничего не делает, если рация отключена в панели. Частота, к которой игроку нельзя присоединиться (рабочая частота или addChannelCheck, который ответил нет), отклоняется с уведомлением "You cannot join this frequency". Присоединение к новой частоте покидает предыдущую активную; частоты, которые игрок только слушает, остаются.

setPlayerCallCopy Anchor Link

Помещает игрока в телефонный звонок или убирает его оттуда. Имя из pma-voice.

Сторона: сервер · Ожидание: нет

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

ПримерCopy 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

Участники частоты. Также отвечает как GetPlayersInRadioChannel. Имя из pma-voice.

Сторона: сервер · Ожидание: нет

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

ВозвращаетCopy Anchor Link

Таблица с ключами по серверному id (в виде строки) со значением true, пока этот участник говорит, иначе false. {} для пустой частоты или неверного значения.

addChannelCheckCopy Anchor Link

Добавляет ваше собственное правило для одной частоты: ваша функция решает, кто может присоединиться. Удаляется, когда ваш ресурс останавливается. Имя из pma-voice.

Сторона: сервер · Ожидание: нет

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

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

Сначала проверяются правила частот из панели; затем ваша функция должна ответить истинным значением. Выбрасывает ошибку, если check не функция.

overrideRadioNameGetterCopy Anchor Link

Заменяет имя, которое участники рации видят друг у друга (когда включено Send names to radio members). Имя из pma-voice.

Сторона: сервер · Ожидание: нет

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

Первый аргумент игнорируется (совместимость с pma-voice); геттер используется для каждой частоты.

isValidPlayerCopy Anchor Link

isValidPlayer(source: number): boolean

true, если ai-voice знает игрока (зашёл и настроен).

setPlayerProximityModeCopy Anchor Link

Переключает игрока на одну из дальностей из панели.

Сторона: сервер · Ожидание: нет

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

ВозвращаетCopy Anchor Link

boolean: true, если переключено. false, если игрок неизвестен, index вне списка или addProximityCheck отказал.

setPlayerRangeCopy Anchor Link

Даёт игроку собственную дальность (мегафон, микрофон на сцене) или возвращает ему выбранную им дальность.

Сторона: сервер · Ожидание: нет

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

ВозвращаетCopy Anchor Link

boolean: true, если установлено. false, если игрок неизвестен, metres вне диапазона 0.5-100 или addProximityCheck отказал.

ПримерCopy Anchor Link

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

// Предмет-мегафон: 30 м, пока его держат.
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

Текущая дальность игрока: index (позиция в списке), distance в метрах, mode (название дальности). null для неизвестного игрока.

toggleMuteCopy Anchor Link

Заглушает игрока или снимает заглушение. То же, что /muteply.

Сторона: сервер · Ожидание: нет

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

ВозвращаетCopy Anchor Link

boolean: true, если заглушение переключено, false для неизвестного игрока. Игрок получает уведомление; срабатывает серверное событие pma-voice:playerMuted. Заглушения хранятся по лицензии, поэтому сохраняются после переподключения.

addProximityCheckCopy Anchor Link

Добавляет правило для смены дальности. Ваша функция получает (source, index, distance); ответ false отклоняет изменение (и клавишей игрока, и экспортами). Удаляется, когда ваш ресурс останавливается.

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

Несколько частотCopy Anchor Link

Дополнительно для телефонаCopy Anchor Link

ПрочееCopy Anchor Link

Клиентские экспортыCopy Anchor Link

Клиентские экспорты pma-voice (все также под exports['pma-voice']):

Собственные клиентские экспорты ai-voice:

State bagsCopy Anchor Link

Пишутся сервером на каждом игроке (Player(source).state, на клиенте LocalPlayer.state). Читайте их; никогда не пишите в них.

GlobalState: ai-voice:backend ("mumble" или "enhanced"), ai-voice:takeover (скрипты, которые приносят собственный эффект рации или телефона). ai-voice читает bag dead из AI Core и bag isDead из pma-voice.

СобытияCopy Anchor Link

Сетевые события pma-voice (pma-voice:syncRadioData, addPlayerToRadio, removePlayerFromRadio, setTalkingOnRadio, clSetPlayerRadio, syncCallData, addPlayerToCall, removePlayerFromCall, clSetPlayerCall) сохраняют свои имена и данные для интерфейсов раций, которые их слушают. События рации передают частоту дополнительным последним аргументом; у таблиц участников строковые ключи.

// Клиент: показывать иконку «в эфире», пока игрок говорит по рации.
on("pma-voice:radioActive", (talking: boolean) => {
  SendNUIMessage({ action: "radio", data: talking });
});