diff --git a/public/scripts/world-info.js b/public/scripts/world-info.js index 2670ccd7e..63f2b29b2 100644 --- a/public/scripts/world-info.js +++ b/public/scripts/world-info.js @@ -97,6 +97,17 @@ export const MAX_SCAN_DEPTH = 1000; const KNOWN_DECORATORS = ['@@activate', '@@dont_activate']; // 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 * @property {number} [scanDepth] The depth of the scan