Logging

Diese Helfer schreiben in die Konsole (F8 auf einem Client, die Server-Konsole oder txAdmin auf dem Server). Für Logs, die der Serverbetreiber in Discord, Fivemanage oder FiveM Stats liest, nutze stattdessen aiLog (siehe Logs).

import { createLogger, logSafe, previewJson } from "@aicore-fivem/lib/shared";

createLoggerCopy Anchor Link

Gibt einen Logger zurück, dessen Zeilen mit [your-resource] beginnen, damit die Server-Konsole zeigt, woher jede Zeile kommt. Warnungen sind gelb, Fehler rot.

Seite: Client, Server und NUI · Wartet: nein

createLogger(resource: string): Logger

Lua: kein Zwilling; nutze print(('[%s] %s'):format(GetCurrentResourceName(), message)).

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

Logger:

BeispielCopy Anchor Link

import { createLogger } from "@aicore-fivem/lib/shared";

const log = createLogger(GetCurrentResourceName());

log.info("loaded 12 shops");               // [my-shop] loaded 12 shops
log.warn("shop legion has no ped model");  // gelb
try {
  JSON.parse("{");
} catch (error) {
  log.error("could not read shops.json", error); // rot, mit dem Fehler
}

logSafeCopy Anchor Link

Macht Text, den ein Client gesendet hat, sicher für die Server-Konsole: eine Zeile (Zeilenumbrüche werden zu |), keine Steuerzeichen, keine ^1-Farbcodes, auf max Zeichen gekürzt. Nutze es immer, wenn eine Log-Zeile Text eines Spielers enthält (einen Namen, eine Nachricht, eine Notiz).

Seite: Client, Server und NUI · Wartet: nein

logSafe(text: string, max: number): string

Lua: kein Zwilling.

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

string: der bereinigte Text.

BeispielCopy Anchor Link

import { logSafe } from "@aicore-fivem/lib/shared";

logSafe("^1fake error\nsecond line", 100); // "fake error | second line"

previewJsonCopy Anchor Link

Ein kurzer JSON-ähnlicher Text eines beliebigen nicht vertrauenswürdigen Werts, bei max Zeichen abgeschnitten, gebaut, ohne zuerst den ganzen Wert zu serialisieren (eine feindliche Nutzlast kann Megabytes groß sein). Verschachtelung tiefer als 4 Ebenen erscheint als [...] / {...}. Nutze es, um auszugeben, was ein Client gesendet hat, wenn du es ablehnst.

Seite: Client, Server und NUI · Wartet: nein

previewJson(value: unknown, max: number): string

Lua: kein Zwilling.

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

string: die Vorschau, höchstens max Zeichen. Objektschlüssel werden auf 50 Zeichen gekürzt.

BeispielCopy Anchor Link

import { onClientEvent } from "@aicore-fivem/lib/server";
import { createLogger, logSafe, previewJson } from "@aicore-fivem/lib/shared";

const log = createLogger(GetCurrentResourceName());

onClientEvent("my-shop:rate", (source) => {
  log.info(`${logSafe(GetPlayerName(String(source)) ?? "?", 32)} opened the rating`);
});

function refuse(source: number, raw: unknown[]): void {
  log.warn(`refused input from ${source}: ${previewJson(raw, 200)}`);
}