AI Core
Référence de l’APIExports client d’ai-core

Exports client d’ai-core

Ce que sont les exports client d’ai-core, comment les appeler depuis TypeScript et Lua, et quel utilitaire de la lib enveloppe chacun.

Un export client est une fonction que le côté client d’ai-core offre à toutes les autres ressources dans le jeu du même joueur. Votre script client l’appelle pour lire les données du joueur local, masquer le HUD, ajouter une entrée au menu radial, vérifier un objet, jouer une emote, etc.

La plupart de ces exports sont des couches : ai-core ne fait pas le travail lui-même, il transmet l’appel au script que le serveur utilise pour cette tâche (l’inventaire, le script de vêtements, le menu radial, le menu d’emotes, le script de mort, le MDT). Votre script appelle un seul nom et continue de fonctionner quand le propriétaire du serveur remplace l’un de ces scripts par un autre.

Avant de commencer

  • Chaque export client est synchrone : il répond tout de suite et n’attend jamais. Rien sur ces pages ne renvoie de Promise, et rien n’a besoin d’un thread en Lua. Le seul export dont la réponse demande du temps (OpenItemPicker) répond par un événement.
  • Appelez-les uniquement depuis du code client. Le serveur a sa propre liste : exports serveur d’ai-core.
  • ai-core doit être démarré. Une ressource qui peut tourner sans ai-core utilise optionalExport("ai-core") en TypeScript (il vaut null tant qu’ai-core est arrêté).
  • Chaque export répond aussi avec la casse de la première lettre inversée : GetPlayerData et getPlayerData sont la même fonction.
  • Ce qu’une ressource ajoute via ces exports (raisons de masquage du HUD, aides de touches, entrées radiales, pauses de la synchro du monde) appartient à cette ressource. ai-core les retire quand la ressource s’arrête, si bien qu’un crash ou un redémarrage ne laisse jamais le HUD masqué ni une entrée de menu morte.

Appeler un export

resource/client/index.ts
import { resourceExport } from "@aicore8/lib/client";

// Un seul handle typé, en haut du fichier. Les types viennent de @aicore8/shared (AiCoreClientExports).
const core = resourceExport("ai-core");

RegisterCommand(
  "myjob",
  () => {
    const data = core.GetPlayerData();
    console.log(data ? `job: ${data.job.job}` : "no character loaded");
  },
  false,
);

Utilisez l’utilitaire de la lib quand il existe

La plupart des exports ont un utilitaire dans @aicore8/lib/client et le même utilitaire sur aiLib pour les ressources Lua (shared_script '@ai-lib/init.lua'). Les utilitaires appellent l’export pour vous, vérifient sa réponse et ajoutent un écouteur de changement quand il en existe un. Préférez-les ; appelez l’export directement quand vous ne pouvez pas utiliser la lib.

ExportLib TypeScriptaiLib LuaPage
GetPlayerData, IsPlayerLoaded, GetDefinitionsgetPlayerData, onPlayerDataaiLib.playerData.get, aiLib.playerData.onChangeJoueur
HideHud, ShowHud, IsHudVisiblehud.hide, hud.show, hud.visible, hud.onChangeaiLib.hud.hide, aiLib.hud.show, aiLib.hud.visibleHUD
OpenHudSettings, HasHudSettingsaucunaucunHUD
ShowKeyHint, HideKeyHintkeyHints.show, keyHints.hideaiLib.keyHints.show, aiLib.keyHints.hideRaccourcis et aides de touches
GetKeybindKey, GetKeyHints, OpenKeyboardaucunaucunRaccourcis et aides de touches
PauseWorldSync, ResumeWorldSyncworld.pauseSync, world.resumeSyncaiLib.world.pauseSync, aiLib.world.resumeSyncSynchro de la météo et de l’heure
OpenInventory, HasItem, GetCurrentWeaponinventory.openInventory, inventory.hasItem, inventory.currentWeaponaiLib.inventory.* (mêmes noms)Objets
OpenItemPickeritemPickeraiLib.itemPickerObjets
AddRadialItem, RemoveRadialItem, RefreshRadialradial.add, radial.remove, radial.refreshaiLib.radial.* (mêmes noms)Menu radial
IsHandsUp, IsPointing, GetGestureProvider, PlayEmote, CancelEmote, GetEmoteProvidergestures.*aiLib.gestures.*Gestes et emotes
ApplyAppearance, GetPedAppearance, OpenClothingMenu, WearOutfit, ReloadSkinappearance.apply, read, openMenu, wearOutfit, reloadSkinaiLib.appearance.* (mêmes noms)Apparence
IsDeadmedical.isDead, medical.onChangeaucun (appelez l’export)Médical
GetSeatbelt, GetSeatbeltProviderseatbelt.isOn, seatbelt.provider, seatbelt.onChangeaiLib.seatbelt.* (mêmes noms)Ceinture de sécurité
OpenMdtmdt.openaiLib.mdt.openMDT
ExternalNotifyaucun (utilisé par ai-lib)aucunNotifications

N’appelez pas les exports à chaque frame

Les exports franchissent la frontière d’une ressource, ce qui coûte plus qu’un appel de fonction local. Lisez une valeur une fois, puis suivez l’événement qui vous dit quand elle change. Chaque page nomme cet événement ; ils sont tous listés dans Événements et état.

Les menus, boîtes de saisie, notifications, invites, la barre de progression et les mini-jeux appartiennent à ai-lib, pas à ai-core. Utilisez notify, menu, input, progress et skillCheck de la lib (ou les mêmes noms sur aiLib).

Sur cette page