Teclas de atalho

Toda tecla que um script escuta é um Keybind: o jogador pode mudá-la nas opções do GTA (Settings > Key Bindings > FiveM), o dono do servidor pode mudar o padrão dela no painel de administração do ai-core (aba Keybinds), e nada verifica teclas a cada frame.

new KeybindCopy Anchor Link

Registra uma tecla reconfigurável. A tecla padrão vem do painel de administração do ai-core quando o dono definiu uma ali, senão de defaultKey. A lib registra o mapeamento da tecla assim que o ai-core respondeu (uma ida e volta na inicialização); sem o ai-core ela usa defaultKey na hora.

Lado: Cliente · Espera: não (o registro termina em segundo plano)

new Keybind(options: KeybindOptions)

local key = aiLib.Keybind.new(options)

ParâmetrosCopy Anchor Link

KeybindOptionsCopy Anchor Link

O tipo da ajuda é KeyHintWhen.

MembrosCopy Anchor Link

ExemploCopy Anchor Link

import { createLocale, Keybind, NuiScreen } from "@aicore-fivem/lib/client";

const Locale = createLocale<typeof import("../../locales/en.json")>();
const screen = new NuiScreen("tablet");

const openKey = new Keybind({
  name: "mytablet_open",
  description: Locale("KEYBIND_OPEN_TABLET"),
  defaultKey: "F5",
  hint: "foot",
  icon: "tablet-screen-button",
  hintLabel: Locale("HINT_TABLET"),
  onPressed: () => {
    if (screen.isOpen) return;
    // Diz à página qual tecla a fecha de novo.
    screen.open({ action: "open", data: { closeKey: openKey.currentKey } });
  },
});

// Enquanto algemado a tecla não faz nada.
export const setCuffed = (cuffed: boolean): void => openKey.disable(cuffed);