Add new WORLDINFO_SCAN_DONE event with mutable state for extensions (#4797) * chore: Add WORLDINFO_SCAN_DONE event with mutable state for extensions * Fix incorrect scan state reference in world info recursion logic * Fix typo in world info scan state property name: 'sucessful' → 'successful' (am i stupid)

a11abc42737015b27be87cb2dfc5c9f63bc272ee

Wolfsblvt <wolfsblvt@gmail.com>

Signed

Parents: 3a3d992bc31a95b3beebbccb63facae4ba9d549b

public/scripts/events.js+1 -0 Viewed

     PRESET_RENAMED_BEFORE: 'preset_renamed_before',
     MAIN_API_CHANGED: 'main_api_changed',
     WORLDINFO_ENTRIES_LOADED: 'worldinfo_entries_loaded',
 +    WORLDINFO_SCAN_DONE: 'worldinfo_scan_done',
     MEDIA_ATTACHMENT_DELETED: 'media_attachment_deleted',
 };

public/scripts/world-info.js+40 -0 Viewed

+        }
         // Final check if we should really continue scan, and extend the current WI recurse buffer
 +        const curScanState = scanState;
         scanState = nextScanState;
         if (scanState) {
             const text = successfulNewEntriesForRecursion

         } else {
             logNextState('[WI] Scan done. No new entries to prompt. Stopping.');
+        }
++
 +        // Fire an event after each scan loop, so extensions can hook into the current scanning state
 +        const args = {
 +            state: {
 +                current: curScanState,
 +                next: scanState,
 +                loopCount: count,
 +            },
 +            new: {
 +                all: newEntries,
 +                successful: successfulNewEntries,
 +            },
 +            activated: {
 +                entries: allActivatedEntries,
 +                text: allActivatedText,
 +            },
 +            sortedEntries,
 +            recursionDelay: {
 +                availableLevels: availableRecursionDelayLevels,
 +                currentLevel: currentRecursionDelayLevel,
 +            },
 +            budget: {
 +                current: budget,
 +                overflowed: token_budget_overflowed,
 +            },
 +            timedEffects,
 +        };
 +        await eventSource.emit(event_types.WORLDINFO_SCAN_DONE, args);
++
 +        // Some fields are allowed to be changed by listeners, those will be handled here manually. They can be updated via changed the args from the listeners.
 +        // Any array provided directly can be modified by updating it's elements, adding or removing elements. This has to be done consistently.
 +        if (args.state.next !== scanState) {
 +            logNextState('[WI] Scan state changed from', scanState, 'to', args.state.next);
 +            scanState = args.state.next;
 +        }
 +        allActivatedText = args.activated.text;
 +        currentRecursionDelayLevel = args.recursionDelay.currentLevel;
 +        budget = args.budget.current;
 +        token_budget_overflowed = args.budget.overflowed;
+    }
     console.debug('[WI] --- BUILDING PROMPT ---');