Add 'speak' effect for NPCs to say multiple phrases over time

bundles/ranvier-areas/areas/limbo/npcs.yml

@@ -10,6 +10,7 @@
   keywords: ["wise", "old", "man"]
   name: "Wise Old Man"
   level: 99
+  script: '2-old-man'
   pacifist: true
   description: "A wise looking old man sits on the ground with legs crossed."
   attributes:

bundles/ranvier-areas/areas/limbo/scripts/npcs/2-old-man.js

@@ -0,0 +1,35 @@
+
+'use strict';
+
+module.exports = (srcPath) => {
+  const Broadcast = require(srcPath + 'Broadcast');
+
+  return  {
+    listeners: {
+      playerEnter: state => function (player) {
+        if (this.hasEffectType('speaking')) {
+          return;
+        }
+
+        const speak = state.EffectFactory.create('speak', this, {}, {
+          messageList: [
+            "Welcome, %player%. The combat training area lies to the east.",
+            "To the west lies Wally's shop where you can stock up on potions.",
+          ],
+          outputFn: message => {
+            message = message.replace(/%player%/, player.name);
+            state.ChannelManager.get('say').send(state, this, message);
+          }
+        });
+        this.addEffect(speak);
+      },
+
+      playerLeave: state => function (player) {
+        const speaking = this.effects.getByType('speaking');
+        if (speaking) {
+          speaking.remove();
+        }
+      }
+    }
+  };
+};

bundles/ranvier-effects/effects/speak.js

@@ -0,0 +1,40 @@
+'use strict';
+
+/**
+ * Have an NPC speak phrases over time
+ */
+module.exports = srcPath => {
+  const Broadcast = require(srcPath + 'Broadcast');
+
+  return {
+    config: {
+      name: 'Speaking',
+      type: 'speaking',
+      tickInterval: 3,
+      persists: false
+    },
+    state: {
+      messageList: [],
+      remainingMessages: null,
+      outputFn: null
+    },
+    listeners: {
+      effectActivated: function () {
+        if (typeof this.state.outputFn !== 'function') {
+          throw new Error('Speak effect has no outputFn configured');
+        }
+
+        // copy original message list to remainingMessages
+        this.state.remainingMessages = this.state.messageList.concat([]);
+      },
+      updateTick: function () {
+        if (!this.state.remainingMessages.length) {
+          return this.remove();
+        }
+
+        const message = this.state.remainingMessages.shift();
+        this.state.outputFn(message);
+      },
+    }
+  };
+};