Apply relevant improvements

- improve docstrings
- use RanvierMUD#74, RanvierMUD#93, RanvierMUD#98, RanvierMUD#100, RanvierMUD#103, RanvierMUD#106, RanvierMUD#109, RanvierMUD#117, RanvierMUD#104, RanvierMUD#119, RanvierMUD#105

Author: azigler

src/Area.js

@@ -87,6 +87,7 @@ class Area extends GameEntity {
    * @fires Area#roomRemoved
    */
   removeRoom(room) {
+    this.removeRoomFromMap(room);
     this.rooms.delete(room.id);
 
     /**
@@ -115,6 +116,26 @@ class Area extends GameEntity {
     floor.addRoom(x, y, room);
   }
 
+  /**
+   * Remove a room from the map
+   * @param {Room} room
+   * @throws Error
+   */
+  removeRoomFromMap(room) {
+    if (!room.coordinates) {
+      throw new Error('Room does not have coordinates');
+    }
+
+    const {x, y, z} = room.coordinates;
+
+    if (!this.map.has(z)) {
+      throw new Error(`That floor doesn't exist`);
+    }
+
+    const floor = this.map.get(z);
+    floor.removeRoom(x, y);
+  }
+
   /**
    * find a room at the given coordinates for this area
    * @param {number} x
@@ -144,7 +165,7 @@ class Area extends GameEntity {
 
   /**
    * This method is automatically called every N milliseconds where N is defined in the
-   * `setInterval` call to `GameState.AreaMAnager.tickAll` in the `ranvier` executable. It, in turn,
+   * `setInterval` call to `GameState.AreaManager.tickAll` in the `ranvier` executable. It, in turn,
    * will fire the `updateTick` event on all its rooms and npcs
    * 
    * @param {GameState} state

src/Attribute.js

@@ -5,7 +5,7 @@
  * safely. Where safely means without being destructive to the base value.
  *
  * An attribute on its own cannot be raised above its base value. To raise attributes above their
- * base temporarily see the {@link http://ranviermud.com/extending/effects|Effect guide}.
+ * base temporarily see the {@link https://ranviermud.com/coding/effects/|Effect guide}.
  *
  * @property {string} name
  * @property {number} base

src/CommandQueue.js

@@ -100,7 +100,6 @@ class CommandQueue {
   /**
    * For a given command index find how many seconds until it will run
    * @param {number} commandIndex
-   * @param {boolean} milliseconds
    * @return {number}
    */
   getTimeTilRun(commandIndex) {

src/Effect.js

@@ -146,27 +146,29 @@ class Effect extends EventEmitter {
     }
 
     this.startedAt = Date.now() - this.elapsed;
+    this.active = true;
+
     /**
      * @event Effect#effectActivated
      */
     this.emit('effectActivated');
-    this.active = true;
   }
 
   /**
-   * Set this effect active
+   * Deactivate this effect
    * @fires Effect#effectDeactivated
    */
   deactivate() {
     if (!this.active) {
       return;
     }
 
+    this.active = false;
+
     /**
      * @event Effect#effectDeactivated
      */
     this.emit('effectDeactivated');
-    this.active = false;
   }
 
   /**

src/EffectFactory.js

@@ -39,6 +39,9 @@ class EffectFactory {
     this.effects.set(id, { definition, eventManager });
   }
 
+  /**
+   * @see Map#has
+   */
   has(id) {
     return this.effects.has(id);
   }
@@ -49,7 +52,8 @@ class EffectFactory {
    * @return {object}
    */
   get(id) {
-    return this.get(id);
+    const entry = this.effects.get(id);
+    if (entry) return entry.definition;
   }
 
   /**

src/EffectList.js

@@ -156,7 +156,7 @@ class EffectList {
     /**
      * @event Character#effectRemoved
      */
-    this.target.emit('effectRemoved');
+    this.target.emit('effectRemoved', effect);
   }
 
   /**

src/Inventory.js

@@ -105,6 +105,10 @@ class Inventory extends Map {
       newItem.hydrate(state, def);
       this.set(uuid, newItem);
       state.ItemManager.add(newItem);
+      /**
+       * @event Item#spawn
+       */
+      newItem.emit('spawn');
     }
   }
 }

src/Item.js

@@ -208,9 +208,11 @@ class Item extends GameEntity {
       Logger.warn('Attempted to hydrate already hydrated item.');
       return false;
     }
+    this.__manager = state.ItemManager;
 
-    // perform deep copy if behaviors is set to prevent sharing of the object between
-    // item instances
+    state.ItemManager.add(this);
+
+    // deep copy behaviors to prevent sharing of the object between item instances
     if (serialized.behaviors) {
       const behaviors = JSON.parse(JSON.stringify(serialized.behaviors));
       this.behaviors = new Map(Object.entries(behaviors));
@@ -241,6 +243,10 @@ class Item extends GameEntity {
         newItem.hydrate(state);
         state.ItemManager.add(newItem);
         this.addItem(newItem);
+        /**
+         * @event Item#spawn
+         */
+        newItem.emit('spawn');
       });
     }
 

src/MobManager.js

@@ -21,11 +21,26 @@ class MobManager {
    */
   removeMob(mob) {
     mob.effects.clear();
+
+    const sourceRoom = mob.sourceRoom;
+    if (sourceRoom) {
+      sourceRoom.area.removeNpc(mob);
+      sourceRoom.removeNpc(mob, true);
+    }
+
     const room = mob.room;
-    if (room) {
-      room.area.removeNpc(mob);
-      room.removeNpc(mob, true);
+    if (room && room !== sourceRoom) {
+      room.removeNpc(mob);
     }
+
+    if (mob.equipment && mob.equipment.size) {
+      mob.equipment.forEach((item, slot) => mob.unequip(slot));
+    }
+  
+    if (mob.inventory && mob.inventory.size) {
+      mob.inventory.forEach(item => item.__manager.remove(item));
+    }
+
     mob.__pruned = true;
     mob.removeAllListeners();
     this.mobs.delete(mob.uuid);

src/Npc.js

@@ -91,6 +91,10 @@ class Npc extends Scriptable(Character) {
       newItem.hydrate(state);
       state.ItemManager.add(newItem);
       this.addItem(newItem);
+      /**
+       * @event Item#spawn
+       */
+      newItem.emit('spawn');
     }
 
     for (let [slot, defaultEqId] of Object.entries(this.defaultEquipment)) {
@@ -99,6 +103,10 @@ class Npc extends Scriptable(Character) {
       newItem.hydrate(state);
       state.ItemManager.add(newItem);
       this.equip(newItem, slot);
+      /**
+       * @event Item#spawn
+       */
+      newItem.emit('spawn');
     }
   }