Add WIGlobalScanData type

This commit is contained in:
Crow
2025-04-16 14:51:24 +01:00
parent 349d46d74a
commit 7748c315d7

View File

@ -97,6 +97,17 @@ export const MAX_SCAN_DEPTH = 1000;
const KNOWN_DECORATORS = ['@@activate', '@@dont_activate']; const KNOWN_DECORATORS = ['@@activate', '@@dont_activate'];
// Typedef area // Typedef area
/**
* @typedef {object} WIGlobalScanData The chat-independent data to be scanned. Each of
* these fields can be enabled for scanning per entry.
* @property {string} personaDescription User persona description
* @property {string} characterDescription
* @property {string} characterPersonality
* @property {string} characterNote
* @property {string} scenario Character defined scenario
* @property {string} creatorNotes
*/
/** /**
* @typedef {object} WIScanEntry The entry that triggered the scan * @typedef {object} WIScanEntry The entry that triggered the scan
* @property {number} [scanDepth] The depth of the scan * @property {number} [scanDepth] The depth of the scan