@warriorjs/core/lib/Space.js

WarriorJS core

'use strict';

Object.defineProperty(exports, "__esModule", {
  value: true
});

var _geography = require('@warriorjs/geography');

const upperLeftWallCharacter = '╔';
const upperRightWallCharacter = '╗';
const lowerLeftWallCharacter = '╚';
const lowerRightWallCharacter = '╝';
const verticalWallCharacter = '║';
const horizontalWallCharacter = '═';
const emptyCharacter = ' ';
const stairsCharacter = '>';

/** Class representing a space in the floor. */
class Space {
  /**
   * Creates a space from a sensed space.
   *
   * @param {SensedSpace} sensedSpace The sensed space.
   * @param {Unit} unit The unit that sensed the space.
   *
   * @returns {Space} The space.
   */
  static from(sensedSpace, unit) {
    const { floor, location, orientation } = unit.position;
    const offset = (0, _geography.getAbsoluteOffset)(sensedSpace.getLocation(), orientation);
    const spaceLocation = (0, _geography.translateLocation)(location, offset);
    return new Space(floor, spaceLocation);
  }

  /**
   * Creates a space.
   *
   * @param {Floor} floor The floor.
   * @param {number[]} location The location as a pair of coordinates [x, y].
   */
  constructor(floor, location) {
    this.floor = floor;
    this.location = location;
  }

  /**
   * Returns the character that represents this space.
   *
   * @returns {string} The character.
   */
  getCharacter() {
    if (this.isUnit()) {
      return this.getUnit().character;
    }

    if (this.isWall()) {
      const [locationX, locationY] = this.location;
      if (locationX < 0) {
        if (locationY < 0) {
          return upperLeftWallCharacter;
        }

        if (locationY > this.floor.height - 1) {
          return lowerLeftWallCharacter;
        }

        return verticalWallCharacter;
      }

      if (locationX > this.floor.width - 1) {
        if (locationY < 0) {
          return upperRightWallCharacter;
        }

        if (locationY > this.floor.height - 1) {
          return lowerRightWallCharacter;
        }

        return verticalWallCharacter;
      }

      return horizontalWallCharacter;
    }

    if (this.isStairs()) {
      return stairsCharacter;
    }

    return emptyCharacter;
  }

  /**
   * Checks if the space is empty (stairs count as empty space).
   *
   * @returns {boolean} Whether the space is empty or not.
   */
  isEmpty() {
    return !this.isUnit() && !this.isWall();
  }

  /**
   * Checks if the stairs are located at this space.
   *
   * @returns {boolean} Whether the stairs are located at this space or not.
   */
  isStairs() {
    return this.floor.isStairs(this.location);
  }

  /**
   * Checks if there is a wall located at this space.
   *
   * @returns {boolean} Whether there is a wall located at this space or not.
   */
  isWall() {
    return this.floor.isOutOfBounds(this.location);
  }

  /**
   * Checks if there is a unit located at this space.
   *
   * @returns {boolean} Whether there is a unit located at this space or not.
   */
  isUnit() {
    return !!this.getUnit();
  }

  /**
   * Returns the unit located at this space (if any).
   *
   * @returns {Unit} The unit.
   */
  getUnit() {
    return this.floor.getUnitAt(this.location);
  }

  /**
   * Returns this space as sensed by the given unit.
   *
   * @param {Unit} unit The unit sensing this space.
   *
   * @returns {SensedSpace} The sensed space.
   */
  as(unit) {
    return {
      getLocation: () => (0, _geography.getRelativeOffset)(this.location, unit.position.location, unit.position.orientation),
      getUnit: () => {
        const spaceUnit = this.getUnit.call(this);
        return spaceUnit && spaceUnit.as(unit);
      },
      isEmpty: this.isEmpty.bind(this),
      isStairs: this.isStairs.bind(this),
      isUnit: this.isUnit.bind(this),
      isWall: this.isWall.bind(this)
    };
  }

  /**
   * Returns the string representation of this space.
   *
   * @returns {string} The string representation.
   */
  toString() {
    if (this.isUnit()) {
      return this.getUnit().toString();
    }

    if (this.isWall()) {
      return 'wall';
    }

    return 'nothing';
  }

  /**
   * Customizes the JSON stringification behavior of the space.
   *
   * @returns {Object} The value to be serialized.
   */
  toJSON() {
    return {
      character: this.getCharacter(),
      unit: this.getUnit()
    };
  }
}

exports.default = Space;
module.exports = exports.default;