Admin-Panel und Befehle

ai-core stellt ein Admin-Panel für jedes Skript bereit. Die meisten Exports auf dieser Seite sind Infrastruktur, die @aicore-fivem/lib für dich aufruft: Ein Skript, das mit AdminPanel und addCommand der Lib gebaut ist, ruft RegisterAdminPanel, AdminPanelChanged oder RegisterCommands nie selbst auf. Sie sind dokumentiert, damit du weißt, was passiert, und sie aus einer anderen Sprache unterstützen kannst. RegisterExternalPanel und GetLookupValues sind für jedes Skript nützlich.

RegisterAdminPanelCopy Anchor Link

Kündigt an, dass die aufrufende Ressource einen Panel-Bereich hat. ai-core fragt sie dann nach ihrem Schema und ihren Daten, sobald ein Admin das Panel öffnet.

Seite: Server · Wartet: nein · Lib: wird von AdminPanel der Lib beim Start aufgerufen

RegisterAdminPanel(resource: string): void

exports['ai-core']:RegisterAdminPanel(GetCurrentResourceName())

ParameterCopy Anchor Link

RückgabeCopy Anchor Link

Nichts. Die Registrierung wird verworfen, wenn die Ressource stoppt.

BeispielCopy Anchor Link

Kein Beispiel: AdminPanel der Lib ruft es auf. Eine Ressource, die sich ohne die Lib registriert, muss auch die Exports beantworten, die ai-core zurückruft (AdminPanelSnapshot, AdminPanelData, AdminPanelSummary, typisiert als AdminPanelResourceExports in @aicore-fivem/shared), was die Aufgabe der Lib ist.

AdminPanelChangedCopy Anchor Link

Eine Panel-Ressource teilt ai-core mit, dass sich einer ihrer Datensätze geändert hat. ai-core leitet die Änderung an jeden Admin weiter, der das Panel geöffnet hat, sodass sich sein Bildschirm ohne Neuladen aktualisiert.

Seite: Server · Wartet: nein · Lib: wird von AdminPanel der Lib nach jeder gespeicherten Änderung aufgerufen

AdminPanelChanged(delta: AdminDelta): void

exports['ai-core']:AdminPanelChanged({ resource = GetCurrentResourceName(), file = 'shops', key = 'shop_1', value = record })

ParameterCopy Anchor Link

Siehe AdminDelta.

RückgabeCopy Anchor Link

Nichts. ai-core prüft das Delta nicht; es sendet es so, wie es übergeben wird.

BeispielCopy Anchor Link

Kein Beispiel: AdminPanel der Lib ruft es auf, nachdem eine Änderung validiert und gespeichert wurde.

RegisterCommandsCopy Anchor Link

Listet die Befehle einer Ressource im Tab Commands (Befehle) des Panels, mit ihrer Hilfe, ihren Parametern und wer sie nutzen darf.

Seite: Server · Wartet: nein · Lib: wird von addCommand der Lib aufgerufen (TypeScript und Lua aiLib.addCommand)

RegisterCommands(resource: string, commands: CommandInfo[]): void

exports['ai-core']:RegisterCommands(GetCurrentResourceName(), commands)

ParameterCopy Anchor Link

Siehe CommandInfo und CommandParam.

RückgabeCopy Anchor Link

Nichts. Die Liste wird verworfen, wenn die Ressource stoppt. Für Befehle, die auf einen Principal beschränkt sind (group.admin), gewährt ai-core diesem Principal außerdem command.<name>, was add_ace resource.ai-core command.add_ace allow (und command.remove_ace) in der permission.cfg braucht.

BeispielCopy Anchor Link

Kein Beispiel: Nutze addCommand der Lib (TypeScript) oder aiLib.addCommand (Lua), und der Befehl erscheint von selbst im Tab. Befehle, die mit einem nackten RegisterCommand erstellt wurden, werden ebenfalls gelistet, als einfach markiert.

GetLookupValuesCopy Anchor Link

Die Werte einer Nachschlageliste: die Item-Namen des aktiven Inventars, die Jobnamen, Gangnamen und so weiter. Die Panel-Validierung der Lib nutzt es, um zu prüfen, dass ein Wert, den ein Admin eingetippt hat, existiert.

Seite: Server · Wartet: nein · Lib: wird von der Validierung von AdminPanel der Lib genutzt

GetLookupValues(source: LookupSource): string[]

local items = exports['ai-core']:GetLookupValues('item') -- Liste von Item-Namen

ParameterCopy Anchor Link

Siehe LookupSource.

RückgabeCopy Anchor Link

string[]: die Werte, nach ihrem Label sortiert. Eine leere Liste für eine unbekannte source, für vehicle und ped und wenn die Liste noch nicht bekannt ist (kein Inventar läuft): Behandle leer als „kann nicht prüfen“, nicht als „nichts ist gültig“.

BeispielCopy Anchor Link

import { resourceExport } from "@aicore-fivem/lib/server";

const core = resourceExport("ai-core");

/** Prüft ein Belohnungs-Item aus deiner Config; unbekannt ist in Ordnung, solange kein Inventar läuft. */
export function isKnownItem(name: string): boolean {
  const items = core.GetLookupValues("item");
  return items.length === 0 || items.includes(name);
}

RegisterExternalPanelCopy Anchor Link

Listet den eigenen Einstellungsbildschirm eines anderen Skripts auf dem Panel-Dashboard von ai-core, sodass der Serverbesitzer die Einstellungen jedes Skripts an einem Ort findet. Die Karte öffnet den Bildschirm mit einem Chat-Befehl oder zeigt eine Webseite innerhalb des Panels.

Seite: Server · Wartet: nein · Lib: keine

RegisterExternalPanel(panel: {
  id?: string;
  label: string;
  icon?: string;
  description?: string;
  command?: string;
  url?: string;
}): void

exports['ai-core']:RegisterExternalPanel({ label = 'My script', command = 'myscriptconfig' })

ParameterCopy Anchor Link

Panel-FelderCopy Anchor Link

RückgabeCopy Anchor Link

Nichts. Ohne label oder ohne sowohl command als auch url wird die Karte nicht hinzugefügt. Karten werden verworfen, wenn deine Ressource stoppt.

BeispielCopy Anchor Link

import { resourceExport } from "@aicore-fivem/lib/server";

const core = resourceExport("ai-core");

// Einmal beim Start.
core.RegisterExternalPanel({
  label: "My script",
  icon: "gear",
  description: "Shops, prices and rewards",
  command: "myscriptconfig",
});