Referência da API
Exports de cliente do ai-core
Todo export de cliente do ai-core - dados do jogador, HUD, dicas de teclas, sincronização do mundo, itens, radial, gestos, aparências e diálogos.
Tipados como AiCoreClientExports em @aicore-fivem/shared (exports.ts).
import { resourceExport } from "@aicore-fivem/lib/client";
const core = resourceExport("ai-core");A maioria tem um helper da lib mais fácil de usar (na última coluna); recursos em Lua têm os mesmos helpers em aiLib.
Jogador
| Export | O quê | Lib |
|---|---|---|
GetPlayerData(): AiPlayerData | null | Os dados do jogador local: personagem, dinheiro, empregos, serviço, emprego, gangues, gangue ativa, metadados. | getPlayerData, onPlayerData |
IsPlayerLoaded(): boolean | Se há um personagem carregado. | |
IsDead(): boolean | O jogador local está caído no script de morte que estiver rodando. | medical.isDead |
GetDefinitions(file: "jobs" | "gangs"): Record<string, unknown> | null | Definições de empregos ou gangues como o arquivo do painel as guarda. |
local data = exports['ai-core']:GetPlayerData()
if data and data.duty == 'police' then
-- on duty
endHUD
| Export | O quê | Lib |
|---|---|---|
HideHud(reason: string): void | Esconde todos os HUDs enquanto houver algum motivo (os motivos de um recurso parado vão junto com ele). | hud.hide |
ShowHud(reason: string): void | Remove um motivo. | hud.show |
IsHudVisible(): boolean | Se os HUDs aparecem agora. | hud.visible |
OpenHudSettings(): boolean | Abre as configurações próprias do HUD em execução; false se não houver. | |
HasHudSettings(): boolean | Se o HUD em execução tem configurações. |
core.HideHud("photo-mode");
// ...
core.ShowHud("photo-mode");exports['ai-core']:HideHud('photo-mode')
exports['ai-core']:ShowHud('photo-mode')Teclas e dicas de teclas
| Export | O quê | Lib |
|---|---|---|
GetKeybindKey(name: string): string | null | A tecla com que um Keybind da lib foi registrado; null até ser registrado. | Keybind.currentKey |
ShowKeyHint(id: string, hint: KeyHintRequest): void | Mostra uma dica de tecla (label, keybind?, key?, icon?) até ser escondida. | keyHints.show |
HideKeyHint(id: string): void | Esconde a dica. | keyHints.hide |
GetKeyHints(): KeyHintView[] | As dicas que os HUDs mostram agora (id, key, label, icon?). | |
OpenKeyboard(): void | Abre a tela de teclas: toda tecla com uma ação. |
exports['ai-core']:ShowKeyHint('noclip_speed', { label = 'Speed', key = 'SHIFT', icon = 'gauge' })Sincronização de clima e hora
| Export | O quê | Lib |
|---|---|---|
PauseWorldSync(reason: string): void | Pausa a sincronização de clima e hora enquanto houver algum motivo (interiores, cenas). | world.pauseSync |
ResumeWorldSync(reason: string): void | Remove um motivo. | world.resumeSync |
IsWorldSyncPaused(): boolean | Se a sincronização está pausada agora. |
Itens
| Export | O quê | Lib |
|---|---|---|
OpenInventory(): void | Abre a tela do inventário do próprio jogador. | inventory.openInventory |
HasItem(item: string, count?: number): boolean | Se o jogador tem o item. | inventory.hasItem |
GetCurrentWeapon(): HeldWeapon | null | O item de arma na mão (name, label, image?). | inventory.currentWeapon |
OpenItemPicker(requestId: number, request: ItemPickerRequest): void | Ferramentas de admin: a grade de itens com busca; o resultado chega como MENU_EVENTS.menuResult. | itemPicker |
Menu radial
Os itens chegam ao menu radial que estiver rodando; o ai-core os remove quando o recurso que os adicionou para.
| Export | O quê | Lib |
|---|---|---|
AddRadialItem(item: RadialItem): void | Adiciona ou substitui um item (id, label, icon?, parent?, items?, canShow?, onPressed?, keepOpen?, whileDead?). | radial.add |
RemoveRadialItem(id: string): void | Remove um item. | radial.remove |
RefreshRadial(): void | Lê de novo cada canShow de uma roda aberta. | radial.refresh |
exports['ai-core']:AddRadialItem({
id = 'myscript_engine', label = 'Engine', icon = 'power-off', parent = 'vehicle',
canShow = function() return IsPedInAnyVehicle(PlayerPedId(), false) end,
onPressed = function() ExecuteCommand('engine') end,
})Gestos
| Export | O quê | Lib |
|---|---|---|
GetGestureProvider(): string | null | O script de emotes que responde a mãos para cima e apontar. | gestures.provider |
IsHandsUp(): boolean | O jogador local está com as mãos para cima. | gestures.isHandsUp |
IsPointing(): boolean | O jogador local está apontando. | gestures.isPointing |
Aparência
| Export | O quê | Lib |
|---|---|---|
ApplyAppearance(ped: number, look: CharacterAppearance): boolean | Coloca uma aparência de GetCharacterAppearance em um ped do mesmo modelo pelo script de roupas ativo. | appearance.apply |
GetPedAppearance(ped: number): CharacterAppearance | null | A aparência que um ped usa agora. | appearance.read |
Os menus, diálogos de entrada, notificações, prompts, barra de progresso e minigames são do ai-lib, não do ai-core: veja Exports dos scripts.