Class CraftsmenPosition

x

y

above

• above(): Position

• Returns Position

  Above postion

  Description

  Get position above

  Example

  const pos = new Position(1, 1);
  const abovePos = pos.above();
  console.log(abovePos); // { x: 1, y: 0 }
  Copy

allNears

• allNears(): [Position, Position, Position, Position, Position, Position, Position, Position]

• Returns [Position, Position, Position, Position, Position, Position, Position, Position]

  List of positions

  Description

  Get 8 positions (top, right, bottom, left, upper left, upper right, lower right, lower left)

  Example

  const pos = new Position(1, 1);
  const [topPos, rightPos, bottomPos, leftPos, upperLeftPos, upperRightPos, lowerRightPos, lowerLeftPos] = pos.allNears();
  console.log(topPos); // { x: 1, y: 0 }
  console.log(rightPos); // { x: 2, y: 1 }
  console.log(bottomPos); // { x: 1, y: 2 }
  console.log(leftPos); // { x: 0, y: 1 }
  console.log(upperLeftPos); // { x: 0, y: 0 }
  console.log(upperRightPos); // { x: 2, y: 0 }
  console.log(lowerRightPos); // { x: 2, y: 2 }
  console.log(lowerLeftPos); // { x: 0, y: 2 }
  Copy

below

• below(): Position

• Returns Position

  Below position

  Description

  Get position below

  Example

  const pos = new Position(1, 1);
  const belowPos = pos.below();
  console.log(belowPos); // { x: 1, y: 2 }
  Copy

clone

• clone(): Position

• Returns Position

  Description

  Clone this object

distance

• distance(pos, formular?): number

• Parameters

  • pos: Position

    Position to calculate distance

  • formular: "mahata" | "euclid" = 'mahata'

    Formular to calculate distance (mahata, euclid)

  Returns number

  Distance between two positions

  Description

  Get distance between two positions

  Example

  const pos1 = new Position(1, 1);
  const pos2 = new Position(1, 2);
  const distance = pos1.distance(pos2);
  console.log(distance); //  | 1 - 1 | + | 2 - 1 | = 1
  Copy

  Example

  const pos1 = new Position(1, 1);
  const pos2 = new Position(1, 2);
  const distance = pos1.distance(pos2, 'euclid');
  console.log(distance); // sqrt((1 - 1) ^ 2 + (2 - 1) ^ 2) = 1
  Copy

down

• down(): Position

• Returns Position

  Position down

  Description

  Get position down

  Example

  const pos = new Position(1, 1);
  const downPos = pos.down();
  console.log(downPos); // { x: 2, y: 1 }
  Copy

getPositionByActionParam

• getPositionByActionParam(param): Position

• Parameters

  • param: EActionParam

    Action param

  Returns Position

  Position by action param

  Description

  Get position by action param

  Example

  const pos = new Position(1, 1);
  const posByActionParam = pos.getPositionByActionParam('UP');
  console.log(posByActionParam); // { x: 1, y: 0 }
  Copy

isEquals

• isEquals(pos): boolean

• Parameters

  • pos: Position

    Position to check

  Returns boolean

  Whether the position is equal

  Description

  Check if the position is equal

  Example

  const pos1 = new Position(1, 1);
  const pos2 = new Position(1, 1);
  const isEqual = pos1.equals(pos2)
  console.log(isEqual) // true
  Copy

isNear

• isNear(pos): boolean

• Parameters

  • pos: Position

    Position to check

  Returns boolean

  Whether the position is near

  Description

  Check if the position is near

  Example

  const pos1 = new Position(1, 1);
  const pos2 = new Position(1, 2);
  const isNear = pos1.isNear(pos2)
  console.log(isNear) // true
  Copy

  Example

  const pos1 = new Position(1, 1);
  const pos2 = new Position(1, 3);
  const isNear = pos1.isNear(pos2)
  console.log(isNear) // false
  Copy

isValid

• isValid(width, height): boolean

• Parameters

  • width: number

    The width of the map

  • height: number

    The height of the map

  Returns boolean

  Whether the position is valid

  Description

  Check if the position is valid

  Example

  const pos = new Position(1, 1);
  const isValid = pos.isValid(10, 10);
  console.log(isValid); // true
  Copy

  Example

  const pos = new Position(-1, 1);
  const isValid = pos.isValid(10, 10);
  console.log(isValid); // false
  Copy

left

• left(): Position

• Returns Position

  Left position

  Description

  Get left position

  Example

  const pos = new Position(1, 1);
  const leftPos = pos.left();
  console.log(leftPos); // { x: 0, y: 1 }
  Copy

lowerLeft

• lowerLeft(): Position

• Returns Position

  Lower left position

  Description

  Get lower left position

  Example

  const pos = new Position(1, 1);
  const lowerLeftPos = pos.lowerLeft();
  console.log(lowerLeftPos); // { x: 0, y: 2 }
  Copy

lowerRight

• lowerRight(): Position

• Returns Position

  Lower right position

  Description

  Get lower right position

  Example

  const pos = new Position(1, 1);
  const lowerRightPos = pos.lowerRight();
  Copy

right

• right(): Position

• Returns Position

  Right position

  Description

  Get right position

  Example

  const pos = new Position(1, 1);
  const rightPos = pos.right();
  console.log(rightPos); // { x: 2, y: 1 }
  Copy

topRightBottomLeft

• topRightBottomLeft(): [Position, Position, Position, Position]

• Returns [Position, Position, Position, Position]

  List of positions

  Description

  Get 4 positions (top, right, bottom, left)

  Example

  const pos = new Position(1, 1);
  const [topPos, rightPos, bottomPos, leftPos] = pos.topRightBottomLeft();
  console.log(topPos); // { x: 1, y: 0 }
  console.log(rightPos); // { x: 2, y: 1 }
  console.log(bottomPos); // { x: 1, y: 2 }
  console.log(leftPos); // { x: 0, y: 1 }
  Copy

up

• up(): Position

• Returns Position

  Position up

  Description

  Get position up

  Example

  const pos = new Position(1, 1);
  const upPos = pos.up();
  console.log(upPos); // { x: 0, y: 1 }
  Copy

upperLeft

• upperLeft(): Position

• Returns Position

  Upper left position

  Description

  Get upper left position

  Example

  const pos = new Position(1, 1);
  const upperLeftPos = pos.upperLeft();
  console.log(upperLeftPos); // { x: 0, y: 0 }
  Copy

upperLeftUpperRightLowerLeftLowerRight

• upperLeftUpperRightLowerLeftLowerRight(): [Position, Position, Position, Position]

• Returns [Position, Position, Position, Position]

  List of positions

  Description

  Get 4 positions (upper left, upper right, lower right, lower left)

  Example

  const pos = new Position(1, 1);
  const [upperLeftPos, upperRightPos, lowerRightPos, lowerLeftPos] = pos.upperLeftUpperRightLowerRightLowerLeft();
  console.log(upperLeftPos); // { x: 0, y: 0 }
  console.log(upperRightPos); // { x: 2, y: 0 }
  console.log(lowerRightPos); // { x: 2, y: 2 }
  console.log(lowerLeftPos); // { x: 0, y: 2 }
  Copy

upperRight

• upperRight(): Position

• Returns Position

  Upper right position

  Description

  Get upper right position

  Example

  const pos = new Position(1, 1);
  const upperRightPos = pos.upperRight();
  console.log(upperRightPos); // { x: 2, y: 0 }
  Copy

x1xh1ywy

• x1xh1ywy(width, height): [Position, Position, Position, Position]

• Parameters

  • width: number

    Width of the map

  • height: number

    Height of the map

  Returns [Position, Position, Position, Position]

  Description

  Get 4 positions [(x, 0), (x, height - 1), (0, y), (width - 1, y)]

Static random

• random(width, height): Position

• Parameters

  • width: number

  • height: number

  Returns Position