Référence de l’API
Exports client d’ai-core
Chaque export client d’ai-core - données du joueur, HUD, aides de touches, synchro du monde, objets, menu radial, gestes, apparences et dialogues.
Typés comme AiCoreClientExports dans @aicore-fivem/shared (exports.ts).
import { resourceExport } from "@aicore-fivem/lib/client";
const core = resourceExport("ai-core");La plupart ont un utilitaire de la lib plus simple à utiliser (dernière colonne) ; les ressources Lua ont les mêmes sur aiLib.
Joueur
| Export | Rôle | Lib |
|---|---|---|
GetPlayerData(): AiPlayerData | null | Les données du joueur local : personnage, argent, métiers, service, métier, gangs, gang actif, métadonnées. | getPlayerData, onPlayerData |
IsPlayerLoaded(): boolean | Si un personnage est chargé. | |
IsDead(): boolean | Le joueur local est à terre, quel que soit le script de mort. | medical.isDead |
GetDefinitions(file: "jobs" | "gangs"): Record<string, unknown> | null | Les définitions de métiers ou de gangs telles que le fichier du panneau les contient. |
local data = exports['ai-core']:GetPlayerData()
if data and data.duty == 'police' then
-- on duty
endHUD
| Export | Rôle | Lib |
|---|---|---|
HideHud(reason: string): void | Masque tous les HUD tant qu’un motif est posé (les motifs d’une ressource arrêtée partent avec elle). | hud.hide |
ShowHud(reason: string): void | Retire un motif. | hud.show |
IsHudVisible(): boolean | Si les HUD s’affichent en ce moment. | hud.visible |
OpenHudSettings(): boolean | Ouvre les réglages propres du HUD en place ; false s’il n’en a pas. | |
HasHudSettings(): boolean | Si le HUD en place a des réglages. |
core.HideHud("photo-mode");
// ...
core.ShowHud("photo-mode");exports['ai-core']:HideHud('photo-mode')
exports['ai-core']:ShowHud('photo-mode')Raccourcis et aides de touches
| Export | Rôle | Lib |
|---|---|---|
GetKeybindKey(name: string): string | null | La touche avec laquelle un Keybind de la lib a été enregistré ; null avant l’enregistrement. | Keybind.currentKey |
ShowKeyHint(id: string, hint: KeyHintRequest): void | Affiche une aide de touche (label, keybind?, key?, icon?) jusqu’à ce qu’elle soit masquée. | keyHints.show |
HideKeyHint(id: string): void | La masque. | keyHints.hide |
GetKeyHints(): KeyHintView[] | Les aides que les HUD affichent en ce moment (id, key, label, icon?). | |
OpenKeyboard(): void | Ouvre l’écran des touches : chaque touche qui a une action. |
exports['ai-core']:ShowKeyHint('noclip_speed', { label = 'Speed', key = 'SHIFT', icon = 'gauge' })Synchro de la météo et de l’heure
| Export | Rôle | Lib |
|---|---|---|
PauseWorldSync(reason: string): void | Met en pause la synchro météo et heure tant qu’un motif est posé (intérieurs, scènes). | world.pauseSync |
ResumeWorldSync(reason: string): void | Retire un motif. | world.resumeSync |
IsWorldSyncPaused(): boolean | Si la synchro est en pause en ce moment. |
Objets
| Export | Rôle | Lib |
|---|---|---|
OpenInventory(): void | Ouvre l’écran d’inventaire du joueur. | inventory.openInventory |
HasItem(item: string, count?: number): boolean | Si le joueur a l’objet. | inventory.hasItem |
GetCurrentWeapon(): HeldWeapon | null | L’objet arme en main (name, label, image?). | inventory.currentWeapon |
OpenItemPicker(requestId: number, request: ItemPickerRequest): void | Outils d’admin : la grille d’objets avec recherche ; le résultat arrive comme MENU_EVENTS.menuResult. | itemPicker |
Menu radial
Les entrées vont au menu radial en place ; ai-core les retire quand la ressource qui les a ajoutées s’arrête.
| Export | Rôle | Lib |
|---|---|---|
AddRadialItem(item: RadialItem): void | Ajoute ou remplace une entrée (id, label, icon?, parent?, items?, canShow?, onPressed?, keepOpen?, whileDead?). | radial.add |
RemoveRadialItem(id: string): void | Retire une entrée. | radial.remove |
RefreshRadial(): void | Relit chaque canShow d’une roue ouverte. | 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,
})Gestes
| Export | Rôle | Lib |
|---|---|---|
GetGestureProvider(): string | null | Le script d’emotes qui gère les mains en l’air et le pointage. | gestures.provider |
IsHandsUp(): boolean | Le joueur local a les mains en l’air. | gestures.isHandsUp |
IsPointing(): boolean | Le joueur local pointe du doigt. | gestures.isPointing |
Apparence
| Export | Rôle | Lib |
|---|---|---|
ApplyAppearance(ped: number, look: CharacterAppearance): boolean | Applique une apparence de GetCharacterAppearance à un ped du même modèle via le script de vêtements actif. | appearance.apply |
GetPedAppearance(ped: number): CharacterAppearance | null | L’apparence que porte un ped en ce moment. | appearance.read |
Les menus, dialogues de saisie, notifications, prompts, barre de progression et mini-jeux appartiennent à ai-lib, pas à ai-core : voir Exports des scripts.