ai-lib para desenvolvedores

O ai-lib carrega o @aicore-fivem/lib para recursos que não empacotam o pacote npm. As funções em si são documentadas uma vez, na referência da lib:

• A lib: visão geral
• Lib: funções do cliente
• Lib: funções do servidor
• Lib: funções compartilhadas
• Lua (aiLib): os equivalentes Lua e a ordem dos argumentos deles

CarregandoCopy Anchor Link

fx_version 'cerulean'
game 'gta5'
lua54 'yes'

dependency 'ai-lib'
shared_script '@ai-lib/init.lua'
client_script 'client.lua'
server_script 'server.lua'

local L = aiLib.locale()
aiLib.notify(L('WELCOME'), 'success')

Exports do clienteCopy Anchor Link

O notify, progress, showPrompt, menu, input, skillCheck e lockpick da lib os chamam por você; use as funções da lib. Eles são tipados como AiLibClientExports em @aicore-fivem/shared (resourceExport("ai-lib")). Avisos, menus e zonas pertencem ao recurso que chama e somem quando ele para.

NotifyCopy Anchor Link

Mostra um cartão de notificação na tela deste jogador.

Lado: Cliente · Espera: não

Notify(notification: Notification): void

exports['ai-lib']:Notify({ text = 'Saved', kind = 'success' })
-- o mesmo pela lib: aiLib.notify('Saved', 'success')

NotificationCopy Anchor Link

RetornoCopy Anchor Link

Nada. Uma notificação sem text é descartada. Quando o dono escolheu outro script de notificação no painel, o cartão vai para lá; se esse script não o aceitar, o ai-lib o desenha.

ExemploCopy Anchor Link

import { notify } from "@aicore-fivem/lib/client";

notify("Your vehicle was stored", "success", 5000);

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

// O mesmo cartão na tela de um jogador, enviado a partir do servidor.
onClientEvent("myscript:collectPay", (source) => {
  notify(source, "You were paid $500", "info");
});

ShowProgress and HideProgressCopy Anchor Link

Mostra a barra de progresso por um tempo, ou a esconde. Só a barra: o script que chama roda a ação, a animação dela e a lógica de cancelamento. Use o progress (cliente) ou o progressFor (servidor) da lib no lugar, que fazem tudo isso.

Lado: Cliente · Espera: não

ShowProgress(label: string, duration: number): void
HideProgress(): void

Enquanto a barra aparece, a tecla de cancelar (Backspace) dispara o evento local ai-lib:client:cancelProgress.

ShowPrompt and HidePromptCopy Anchor Link

Mostra ou atualiza um dos avisos do recurso que chama, ou o esconde. Use showPrompt / hidePrompt da lib, ou melhor, o Points da lib, que mostra e esconde avisos pela distância para você.

Lado: Cliente · Espera: não

ShowPrompt(id: string, text: string, at?: PromptAnchor): void
HidePrompt(id: string): void

Quando o jogador aperta a tecla de interação enquanto o seu aviso está em cima, o evento local ai-lib:client:promptPressed (resource, id) dispara; o onPromptPressed da lib o filtra para o seu recurso.

CloseDialogCopy Anchor Link

Fecha o menu ou a caixa de entrada aberta do recurso que chama. A chamada menu.show / input que está esperando responde null, como se o jogador a tivesse fechado. Lado: Cliente · Espera: não.

CloseDialog(): void

Exports internosCopy Anchor Link

Estes são usados pelas próprias funções da lib. Você não os chama.

EventosCopy Anchor Link

// Servidor: uma notificação sem a lib.
emitNet("ai-lib:client:notify", source, { text: "Welcome to the city", kind: "info", duration: 6000 });