add Sequential Effect effect

backend/effects/builtInEffectLoader.js

@@ -31,6 +31,7 @@ exports.loadEffects = () => {
     const runCommand = require('./builtin/runCommand');
     const customScript = require('./builtin/customScript');
     const clearEffects = require('./builtin/clearEffects');
+    const sequentialEffect = require("./builtin/sequentialEffect");
 
     // register them
     effectManager.registerEffect(playSoundEffect);
@@ -60,4 +61,5 @@ exports.loadEffects = () => {
     effectManager.registerEffect(runCommand);
     effectManager.registerEffect(customScript);
     effectManager.registerEffect(clearEffects);
+    effectManager.registerEffect(sequentialEffect);
 };

backend/effects/builtin/sequentialEffect.js

@@ -0,0 +1,145 @@
+"use strict";
+
+const effectRunner = require("../../common/effect-runner");
+
+const { ControlKind, InputEvent } = require('../../interactive/constants/MixplayConstants');
+const effectModels = require("../models/effectModels");
+const { EffectTrigger } = effectModels;
+
+
+const sequentialQueuesCache = {};
+
+const model = {
+    /**
+   * The definition of the Effect
+   */
+    definition: {
+        id: "firebot:sequentialeffect",
+        name: "Run Sequential Effect",
+        description: "Run a single effect sequentially from a list of effects",
+        tags: ["Logic control", "Built in"],
+        dependencies: [],
+        triggers: effectModels.buildEffectTriggersObject(
+            [ControlKind.BUTTON, ControlKind.TEXTBOX],
+            [InputEvent.MOUSEDOWN, InputEvent.KEYDOWN, InputEvent.SUBMIT],
+            EffectTrigger.ALL
+        )
+    },
+    /**
+   * Global settings that will be available in the Settings tab
+   */
+    globalSettings: {},
+    /**
+   * The HTML template for the Options view (ie options when effect is added to something such as a button.
+   * You can alternatively supply a url to a html file via optionTemplateUrl
+   */
+    optionsTemplate: `
+    
+
+    <eos-container>
+        <p>This effect will run a single effect sequentially from the list below. Particularly useful in Timers!</p>
+    </eos-container>
+
+    <eos-container pad-top="true">
+        <effect-list effects="effect.effectList" 
+            trigger="{{trigger}}" 
+            update="effectListUpdated(effects)"
+            header="Effects"
+            modalId="{{modalId}}"></effect-list>
+    </eos-container>
+    
+    
+    `,
+    /**
+   * The controller for the front end Options
+   */
+    optionsController: $scope => {
+        if ($scope.effect.effectList == null) {
+            $scope.effect.effectList = [];
+        }
+
+        $scope.effectListUpdated = function(effects) {
+            $scope.effect.effectList = effects;
+        };
+    },
+    /**
+   * When the effect is saved
+   */
+    optionsValidator: effect => {
+        let errors = [];
+        return errors;
+    },
+    /**
+   * When the effect is triggered by something
+   */
+    onTriggerEvent: event => {
+        return new Promise(resolve => {
+
+            let effect = event.effect;
+            let effectList = effect.effectList;
+
+            if (!effectList || !effectList.list) {
+                return resolve(true);
+            }
+
+            let chosenEffect = null;
+
+            const containsAll = (arr1, arr2) =>
+                arr2.every(arr2Item => arr1.includes(arr2Item));
+
+            // get array of effect ids in this seq effect
+            let newEffectIds = effectList.list.map(e => e.id);
+
+            // try to find queue in cache
+            let cacheEntry = sequentialQueuesCache[effect.id];
+            if (!cacheEntry) {
+                // we dont have a preexisting queue in the cache, create a new one
+                cacheEntry = {
+                    queue: newEffectIds,
+                    currentEffectIds: newEffectIds
+                };
+
+                // add to the cache
+                sequentialQueuesCache[effect.id] = cacheEntry;
+            } else {
+                // theres an existing queue in the cache, check if the effect list has changed at all since last time
+                // and if so, rebuild the queue
+                let effectsHaventChanged = containsAll(newEffectIds, cacheEntry.currentEffectIds);
+                if (!effectsHaventChanged) {
+                    cacheEntry.currentEffectIds = newEffectIds;
+                    cacheEntry.queue = newEffectIds;
+                }
+            }
+
+
+            if (cacheEntry.queue.length === 0) {
+                // We need to make a new queue
+                cacheEntry.queue = newEffectIds;
+            }
+
+            // gets the next effect from beginning of queue and removes it
+            let chosenEffectId = cacheEntry.queue.shift();
+            cacheEntry.lastEffectId = chosenEffectId;
+            chosenEffect = effectList.list.find(e => e.id === chosenEffectId);
+
+            if (chosenEffect == null) {
+                return resolve(true);
+            }
+
+            let processEffectsRequest = {
+                trigger: event.trigger,
+                effects: {
+                    id: effectList.id,
+                    list: [chosenEffect],
+                    queue: effectList.queue
+                }
+            };
+
+            effectRunner.processEffects(processEffectsRequest).then(() => {
+                resolve(true);
+            });
+        });
+    }
+};
+
+module.exports = model;