import { MacroRegistry, MacroCategory, MacroValueType } from '../engine/MacroRegistry.js'; /** * Registers variable-related {{...}} macros that operate on local and global * variables (e.g. {{setvar}}, {{getvar}}, {{incvar}}, etc.). */ export function registerVariableMacros() { const ctx = SillyTavern.getContext(); // {{setvar::name::value}} -> '' (side-effect on local variable) MacroRegistry.registerMacro('setvar', { category: MacroCategory.VARIABLE, unnamedArgs: [ { name: 'name', type: MacroValueType.STRING, description: 'The name of the local variable to set.', }, { name: 'value', type: [MacroValueType.STRING, MacroValueType.NUMBER], description: 'The value to set the local variable to.', }, ], description: 'Sets a local variable to the given value.', returns: '', exampleUsage: ['{{setvar::myvar::foo}}', '{{setvar::myintvar::3}}'], handler: ({ unnamedArgs: [name, value] }) => { ctx.variables.local.set(name, value); return ''; }, }); // {{addvar::name::value}} -> '' (side-effect via addLocalVariable) MacroRegistry.registerMacro('addvar', { category: MacroCategory.VARIABLE, unnamedArgs: [ { name: 'name', type: MacroValueType.STRING, description: 'The name of the local variable to add to.', }, { name: 'value', type: [MacroValueType.STRING, MacroValueType.NUMBER], description: 'The value to add to the local variable.', }, ], description: 'Adds a value to an existing local variable (numeric or string append). If the variable does not exist, it will be created.', returns: '', exampleUsage: ['{{addvar::mystrvar::foo}}', '{{addvar::myintvar::3}}'], handler: ({ unnamedArgs: [name, value] }) => { ctx.variables.local.add(name, value); return ''; }, }); // {{incvar::name}} -> returns new value MacroRegistry.registerMacro('incvar', { category: MacroCategory.VARIABLE, unnamedArgs: [ { name: 'name', type: MacroValueType.STRING, description: 'The name of the local variable to increment.', }, ], description: 'Increments a local variable by 1 and returns the new value. If the variable does not exist, it will be created.', returns: 'The new value of the local variable.', returnType: MacroValueType.NUMBER, exampleUsage: ['{{incvar::myintvar}}'], handler: ({ unnamedArgs: [name], normalize }) => { const result = ctx.variables.local.inc(name); return normalize(result); }, }); // {{decvar::name}} -> returns new value MacroRegistry.registerMacro('decvar', { category: MacroCategory.VARIABLE, unnamedArgs: [ { name: 'name', type: MacroValueType.STRING, description: 'The name of the local variable to decrement.', }, ], description: 'Decrements a local variable by 1 and returns the new value. If the variable does not exist, it will be created.', returns: 'The new value of the local variable.', returnType: MacroValueType.NUMBER, exampleUsage: ['{{decvar::myintvar}}'], handler: ({ unnamedArgs: [name], normalize }) => { const result = ctx.variables.local.dec(name); return normalize(result); }, }); // {{getvar::name}} -> returns current value MacroRegistry.registerMacro('getvar', { category: MacroCategory.VARIABLE, unnamedArgs: [ { name: 'name', type: MacroValueType.STRING, description: 'The name of the local variable to get.', }, ], description: 'Gets the value of a local variable.', returns: 'The value of the local variable.', returnType: [MacroValueType.STRING, MacroValueType.NUMBER], exampleUsage: ['{{getvar::myvar}}', '{{getvar::myintvar}}'], handler: ({ unnamedArgs: [name], normalize }) => { const result = ctx.variables.local.get(name); return normalize(result); }, }); // {{setglobalvar::name::value}} -> '' MacroRegistry.registerMacro('setglobalvar', { category: MacroCategory.VARIABLE, unnamedArgs: [ { name: 'name', type: MacroValueType.STRING, description: 'The name of the global variable to set.', }, { name: 'value', type: [MacroValueType.STRING, MacroValueType.NUMBER], description: 'The value to set the global variable to.', }, ], description: 'Sets a global variable to the given value.', returns: '', exampleUsage: ['{{setglobalvar::myvar::foo}}', '{{setglobalvar::myintvar::3}}'], handler: ({ unnamedArgs: [name, value] }) => { ctx.variables.global.set(name, value); return ''; }, }); // {{addglobalvar::name::value}} -> '' MacroRegistry.registerMacro('addglobalvar', { category: MacroCategory.VARIABLE, unnamedArgs: [ { name: 'name', type: MacroValueType.STRING, description: 'The name of the global variable to add to.', }, { name: 'value', type: [MacroValueType.STRING, MacroValueType.NUMBER], description: 'The value to add to the global variable.', }, ], description: 'Adds a value to an existing global variable (numeric or string append). If the variable does not exist, it will be created.', returns: '', exampleUsage: ['{{addglobalvar::mystrvar::foo}}', '{{addglobalvar::myintvar::3}}'], handler: ({ unnamedArgs: [name, value] }) => { ctx.variables.global.add(name, value); return ''; }, }); // {{incglobalvar::name}} -> returns new value MacroRegistry.registerMacro('incglobalvar', { category: MacroCategory.VARIABLE, unnamedArgs: [ { name: 'name', type: MacroValueType.STRING, description: 'The name of the global variable to increment.', }, ], description: 'Increments a global variable by 1 and returns the new value. If the variable does not exist, it will be created.', returns: 'The new value of the global variable.', returnType: MacroValueType.NUMBER, handler: ({ unnamedArgs: [name], normalize }) => { const result = ctx.variables.global.inc(name); return normalize(result); }, }); // {{decglobalvar::name}} -> returns new value MacroRegistry.registerMacro('decglobalvar', { category: MacroCategory.VARIABLE, unnamedArgs: [ { name: 'name', type: MacroValueType.STRING, description: 'The name of the global variable to decrement.', }, ], description: 'Decrements a global variable by 1 and returns the new value. If the variable does not exist, it will be created.', returns: 'The new value of the global variable.', returnType: MacroValueType.NUMBER, exampleUsage: ['{{decglobalvar::myintvar}}'], handler: ({ unnamedArgs: [name], normalize }) => { const result = ctx.variables.global.dec(name); return normalize(result); }, }); // {{getglobalvar::name}} -> returns current value MacroRegistry.registerMacro('getglobalvar', { category: MacroCategory.VARIABLE, unnamedArgs: [ { name: 'name', type: MacroValueType.STRING, description: 'The name of the global variable to get.', }, ], description: 'Gets the value of a global variable.', returns: 'The value of the global variable.', returnType: [MacroValueType.STRING, MacroValueType.NUMBER], exampleUsage: ['{{getglobalvar::myvar}}', '{{getglobalvar::myintvar}}'], handler: ({ unnamedArgs: [name], normalize }) => { const result = ctx.variables.global.get(name); return normalize(result); }, }); }