@casual-simulation/aux-runtime 3.5.3-alpha.16326443512 → 3.5.4

package/runtime/AuxLibraryDefinitions.def

@@ -12294,6 +12294,22 @@ export interface GeoJSONMapLayer extends MapLayerBase {
     data?: object;
 }
 
+/**
+ * The function signature of a dynamic bot listener.
+ *
+ * That is, a listener that is registered at runtime by a user script instead of parsed from a tag.
+ *
+ * @dochash types/core
+ * @docgroup 01-core
+ * @docname Listener
+ * @docid DynamicListener
+ */
+export type DynamicListener = (
+    that: any,
+    bot: Bot,
+    tagName: string
+) => any;
+
 interface Ai {
     /**
      * Sends a chat message to the AI.
@@ -12801,6 +12817,34 @@ interface Ai {
 }
 
 interface Os {
+
+    /**
+     * Adds the given listener to the given bot for the given tag.
+     * 
+     * @param bot The bot that the listener should be added to.
+     * @param tagName The name of the tag that the listener should be added to.
+     * @param listener The listener that should be added to the bot.
+     * 
+     * @dochash actions/os/event
+     * @docgroup 02-event-actions
+     * @docname os.addBotListener
+     * @docid os.addBotListener
+     */
+    addBotListener(bot: Bot, tagName: string, listener: DynamicListener): void;
+    
+    /**
+     * Removes the given listener from a bot for a specific tag.
+     * @param bot The bot that the listener should be removed from.
+     * @param tagName The name of the tag that the listener should be removed from.
+     * @param listener The listener that should be removed from the bot.
+     * 
+     * @dochash actions/os/event
+     * @docgroup 02-event-actions
+     * @docname os.removeBotListener
+     * @docid os.removeBotListener
+     */
+    removeBotListener(bot: Bot, tagName: string, listener: DynamicListener): void;
+
     /**
          * Sleeps for time in ms.
          * @param time Time in ms. 1 second is 1000ms.

package/runtime/AuxRuntime.d.ts

@@ -1,4 +1,4 @@
-import type { StateUpdatedEvent, Bot, BotSpace, RuntimeBot, CompiledBotListener, BotModuleResult, ResolvedBotModule, ImportMetadata } from '@casual-simulation/aux-common/bots';
+import type { StateUpdatedEvent, Bot, BotSpace, RuntimeBot, BotModuleResult, ResolvedBotModule, ImportMetadata, DynamicListener } from '@casual-simulation/aux-common/bots';
 import type { Observable, SubscriptionLike } from 'rxjs';
 import type { AuxGlobalContext } from './AuxGlobalContext';
 import type { AuxLibrary } from './AuxLibrary';
@@ -90,6 +90,7 @@ export declare class AuxRuntime implements RuntimeBotInterface, RuntimeBotFactor
      * The number of times that the runtime can call onError for an error from the same script.
      */
     repeatedErrorLimit: number;
+    get library(): AuxLibrary;
     get context(): AuxGlobalContext;
     get currentVersion(): RuntimeStateVersion;
     get globalObject(): any;
@@ -231,11 +232,16 @@ export declare class AuxRuntime implements RuntimeBotInterface, RuntimeBotFactor
     getRawValue(bot: CompiledBot, tag: string): any;
     updateTagMask(bot: CompiledBot, tag: string, spaces: string[], value: any): RealtimeEditConfig;
     getTagMask(bot: CompiledBot, tag: string): any;
-    getListener(bot: CompiledBot, tag: string): CompiledBotListener;
+    getListener(bot: CompiledBot, tag: string): DynamicListener | null;
+    setListener(bot: CompiledBot, tag: string, listener: DynamicListener | null): void;
+    getDynamicListeners(bot: CompiledBot, tag: string): DynamicListener[] | null;
+    addDynamicListener(bot: CompiledBot, tag: string, listener: DynamicListener): void;
+    removeDynamicListener(bot: CompiledBot, tag: string, listener: DynamicListener): void;
     getTagLink(bot: CompiledBot, tag: string): RuntimeBot | RuntimeBot[];
     getSignature(bot: CompiledBot, signature: string): string;
     private _compileTagOrMask;
     private _compileTag;
+    private _updateListenerPresense;
     private _compileTagValue;
     private _compileValue;
     private _compileTagMaskValue;

package/runtime/AuxRuntime.js

@@ -72,6 +72,9 @@ async function _importInterpreterCore() {
  * This means taking state updates events, shouts and whispers, and emitting additional events to affect the future state.
  */
 export class AuxRuntime {
+    get library() {
+        return this._library;
+    }
     get context() {
         return this._globalContext;
     }
@@ -1702,6 +1705,8 @@ export class AuxRuntime {
                         newBot.masks[space] = newMasks;
                     }
                 }
+                newBot.dynamicListeners = existing.dynamicListeners;
+                newBot.listenerOverrides = existing.listenerOverrides;
                 existing.script[REPLACE_BOT_SYMBOL](newBot.script);
             }
             let precalculated = {
@@ -2152,6 +2157,8 @@ export class AuxRuntime {
             precalculated: true,
             tags: fromFactory ? bot.tags : { ...bot.tags },
             listeners: {},
+            listenerOverrides: {},
+            dynamicListeners: {},
             modules: {},
             exports: {},
             values: {},
@@ -2345,12 +2352,50 @@ export class AuxRuntime {
         return undefined;
     }
     getListener(bot, tag) {
-        const listener = bot.listeners[tag];
-        if (listener) {
-            return listener;
+        return bot.listenerOverrides[tag] || bot.listeners[tag] || null;
+    }
+    setListener(bot, tag, listener) {
+        if (hasValue(listener)) {
+            bot.listenerOverrides[tag] = listener;
+        }
+        else {
+            delete bot.listenerOverrides[tag];
+        }
+        this._updateListenerPresense(bot, tag);
+    }
+    getDynamicListeners(bot, tag) {
+        if (bot.dynamicListeners && bot.dynamicListeners[tag]) {
+            return bot.dynamicListeners[tag];
+        }
+        return null;
+    }
+    addDynamicListener(bot, tag, listener) {
+        if (!bot.dynamicListeners) {
+            bot.dynamicListeners = {};
+        }
+        if (!bot.dynamicListeners[tag]) {
+            bot.dynamicListeners[tag] = [];
+        }
+        const listeners = bot.dynamicListeners[tag];
+        if (listeners.includes(listener)) {
+            // If the listener already exists, do not add it again.
+            return;
+        }
+        listeners.push(listener);
+        this._updateListenerPresense(bot, tag);
+    }
+    removeDynamicListener(bot, tag, listener) {
+        if (bot.dynamicListeners && bot.dynamicListeners[tag]) {
+            const listeners = bot.dynamicListeners[tag];
+            const index = listeners.indexOf(listener);
+            if (index >= 0) {
+                listeners.splice(index, 1);
+                if (listeners.length <= 0) {
+                    delete bot.dynamicListeners[tag];
+                }
+                this._updateListenerPresense(bot, tag);
+            }
         }
-        this.getValue(bot, tag);
-        return bot.listeners[tag] || null;
     }
     getTagLink(bot, tag) {
         const tagValue = bot.values[tag];
@@ -2443,15 +2488,20 @@ export class AuxRuntime {
         }
         this._compileTagValue(bot, tag, tagValue);
     }
+    _updateListenerPresense(bot, tag) {
+        this._globalContext.recordListenerPresense(bot.id, tag, !!bot.listenerOverrides[tag] ||
+            !!bot.listeners[tag] ||
+            !!bot.dynamicListeners[tag]);
+    }
     _compileTagValue(bot, tag, tagValue) {
         let { value, listener, module } = this._compileValue(bot, tag, tagValue);
         if (listener) {
             bot.listeners[tag] = listener;
-            this._globalContext.recordListenerPresense(bot.id, tag, true);
+            this._updateListenerPresense(bot, tag);
         }
         else if (!!bot.listeners[tag]) {
             delete bot.listeners[tag];
-            this._globalContext.recordListenerPresense(bot.id, tag, false);
+            this._updateListenerPresense(bot, tag);
         }
         if (module) {
             bot.modules[tag] = module;
@@ -2713,7 +2763,13 @@ export class AuxRuntime {
                 // Default import function
                 [`_${IMPORT_FACTORY}`]: () => (module, meta) => this._importModule(module, meta),
             },
-            arguments: [['that', 'data'], IMPORT_FACTORY, EXPORT_FACTORY],
+            arguments: [
+                ['that', 'data'],
+                '$__bot',
+                '$__tag',
+                IMPORT_FACTORY,
+                EXPORT_FACTORY,
+            ],
         });
         if (hasValue(bot)) {
             this._functionMap.set(functionName, func);
@@ -2727,7 +2783,10 @@ export class AuxRuntime {
                 };
                 const exportFunc = (valueOrSource, exp) => exports(valueOrSource, exp, meta);
                 return this._wrapWithCurrentPromise(() => {
-                    let result = func(null, importFunc, exportFunc);
+                    // Pass null for the argument, bot, and tag
+                    // because module functions do not accept arguments
+                    // and have the bot and tag injected automatically
+                    let result = func(null, null, null, importFunc, exportFunc);
                     this._scheduleJobQueueCheck();
                     return result;
                 });