Add a name argument for /getchatbook Closes #2599

e960ae64c541f4aeffab2033daf5dc0afa444c37

Cohee <18619528+Cohee1207@users.noreply.github.com>

public/scripts/world-info.js+28 -3 Viewed

         return entries;
+    }
-    async function getChatBookCallback() {
+    /**
+     * Gets the name of the chat-bound lorebook. Creates a new one if it doesn't exist.
+     * @param {import('./slash-commands/SlashCommandParser.js').NamedArguments} args Named arguments
+     * @returns
+     */
+    async function getChatBookCallback(args) {
         const chatId = getCurrentChatId();
         if (!chatId) {

             return chat_metadata[METADATA_KEY];
+        }
-        // Replace non-alphanumeric characters with underscores, cut to 64 characters
+        const name = (() => {
-        const name = `Chat Book ${getCurrentChatId()}`.replace(/[^a-z0-9]/gi, '_').replace(/_{2,}/g, '_').substring(0, 64);
+            // Use the provided name if it's not in use
+            if (typeof args.name === 'string') {
+                const name = String(args.name);
+                if (world_names.includes(name)) {
+                    throw new Error('This World Info file name is already in use');
+                }
+                return name;
+            }
+            // Replace non-alphanumeric characters with underscores, cut to 64 characters
+            return `Chat Book ${getCurrentChatId()}`.replace(/[^a-z0-9]/gi, '_').replace(/_{2,}/g, '_').substring(0, 64);
+        })();
         await createNewWorldInfo(name);
         chat_metadata[METADATA_KEY] = name;

         callback: getChatBookCallback,
         returns: 'lorebook name',
         helpString: 'Get a name of the chat-bound lorebook or create a new one if was unbound, and pass it down the pipe.',
+        namedArgumentList: [
+            SlashCommandNamedArgument.fromProps({
+                name: 'name',
+                description: 'lorebook name if creating a new one, will be auto-generated otherwise',
+                typeList: [ARGUMENT_TYPE.STRING],
+                isRequired: false,
+                acceptsMultiple: false,
+            }),
+        ],
         aliases: ['getchatlore', 'getchatwi'],
     }));