Add WIGlobalScanData type

7748c315d7d33a1d6b29fef23bf76d12958493f1

Crow <bismuthglass@protonmail.com>

Parents: 349d46d74a03732dbe03fc88936c900da4bba37f
1 files changed, +11 -0Ignore whitespace
public/scripts/world-info.js+11 -0
@@ -98,6 +98,17 @@ const KNOWN_DECORATORS = ['@@activate', '@@dont_activate'];
9898
9999// Typedef area
100100/**
101+ * @typedef {object} WIGlobalScanData The chat-independent data to be scanned. Each of
102+ * these fields can be enabled for scanning per entry.
103+ * @property {string} personaDescription User persona description
104+ * @property {string} characterDescription
105+ * @property {string} characterPersonality
106+ * @property {string} characterNote
107+ * @property {string} scenario Character defined scenario
108+ * @property {string} creatorNotes
109+ */
110+
111+/**
101112 * @typedef {object} WIScanEntry The entry that triggered the scan
102113 * @property {number} [scanDepth] The depth of the scan
103114 * @property {boolean} [caseSensitive] If the scan is case sensitive