shared/Rectangle.js

  1. 'use strict';
  3. /**
  4.  * A rectangular hitbox. Remember that this rectangle describes the item as if
  5.  * its settings were x=0, y=0, scale=1, rotation=0.
  6.  *
  7.  * @memberof module:shared
  8.  * @implements {module:shared.Hitbox}
  9.  *
  10.  * @param {number} width - The width of the rectangle.
  11.  * @param {number} height - The height of the rectangle.
  12.  * @param {number} [x=0] - The x offset of the rectangle.
  13.  * @param {number} [y=0] - The y offset of the rectangle.
  14.  */
  15. class Rectangle {
  16.   constructor(width, height, x = 0, y = 0) {
  17.     /**
  18.      * The width of the rectangle.
  19.      *
  20.      * @type {number}
  21.      */
  22.     this.width = width;
  24.     /**
  25.      * The height of the rectangle.
  26.      *
  27.      * @type {number}
  28.      */
  29.     this.height = height;
  31.     /**
  32.      * The x coordinate of the rectangle.
  33.      *
  34.      * @type {number}
  35.      */
  36.     this.x = x;
  38.     /**
  39.      * The y coordinate of the rectangle.
  40.      *
  41.      * @type {number}
  42.      */
  43.     this.y = y;
  44.   }
  46.   /**
  47.    * Determines if a point is inside the rectangle.
  48.    *
  49.    * @param {module:shared.Point2D} point - The point to test.
  50.    *
  51.    * @return {boolean} true if the point is inside the rectangle, false
  52.    * otherwise.
  53.    */
  54.   contains(point) {
  55.     return point.x >= this.x && point.x <= this.x + this.width && point.y >= this.y && point.y <= this.y + this.height;
  56.   }
  57. }
  59. module.exports = Rectangle;