server/ServerElement.js

  1. 'use strict';
  3. const { EventEmitter } = require('node:events');
  4. const { Message, WamsElement } = require('../shared.js');
  5. const { Hittable, Identifiable } = require('../mixins.js');
  7. /**
  8.  * HACK to get around jsdoc bug that causes mixed methods and properties to be
  9.  * duplicated.
  10.  *
  11.  * @class __ServerElement
  12.  * @private
  13.  * @mixes module:mixins.Hittable
  14.  * @mixes module:mixins.Identifiable
  15.  */
  17. /**
  18.  * The ServerElement provides operations for the server to locate and move
  19.  * elements around.
  20.  *
  21.  * @memberof module:server
  22.  * @extends module:shared.WamsElement
  23.  * @extends __ServerElement
  24.  *
  25.  * @param {Namespace} namespace - Socket.io namespace for publishing changes.
  26.  * @param {Object} values - User-supplied data detailing the elements.
  27.  */
  28. class ServerElement extends Identifiable(Hittable(WamsElement)) {
  29.   constructor(namespace, values = {}) {
  30.     super(values);
  32.     /**
  33.      * Socket.io namespace for publishing updates.
  34.      *
  35.      * @type {Namespace}
  36.      */
  37.     this.namespace = namespace;
  38.   }
  40.   /*
  41.    * Publish a general notification about the status of the image.
  42.    */
  43.   _emitPublication() {
  44.     this.namespace.emit(Message.UD_ITEM, this);
  45.   }
  47.   /**
  48.    * Remove attributes from the element.
  49.    *
  50.    * @param {string[]} attributes
  51.    */
  52.   removeAttributes(attributes) {
  53.     attributes.forEach((attr) => {
  54.       delete this.attributes[attr];
  55.     });
  56.     this.namespace.emit(Message.RM_ATTRS, { id: this.id, attributes });
  57.   }
  59.   /**
  60.    * Set attributes for the element.
  61.    *
  62.    * @param {object} attributes
  63.    */
  64.   setAttributes(attributes) {
  65.     this.attributes = Object.assign(this.attributes, attributes);
  66.     this.namespace.emit(Message.SET_ATTRS, { id: this.id, attributes });
  67.   }
  68. }
  70. Object.assign(ServerElement.prototype, EventEmitter.prototype);
  72. module.exports = ServerElement;