Class Cartographer

Cartographer: provides helper methods related to Game.map. A few of these methods have been modified from BonzAI codebase, although I have introduced new methods of my own over time as well.

Hierarchy

Cartographer

Index

Methods

Methods

Static Private _recursiveRoomSearch

_recursiveRoomSearch(roomName: string, depth: number, maxDepth: number, visited: object): object

- Defined in utilities/Cartographer.ts:48
The recursive part of recursiveRoomSearch. Yields inverted results mapping roomName to depth.

Parameters
- roomName: string
- depth: number
- maxDepth: number
- visited: object
  - [roomName: string]: number
Returns object
- [roomName: string]: number

Static findRelativeRoomDir

findRelativeRoomDir(origin: string, otherRoom: string): number

- Defined in utilities/Cartographer.ts:136
Parameters
- origin: string
- otherRoom: string
Returns number

Static findRelativeRoomName

findRelativeRoomName(roomName: string, xDelta: number, yDelta: number): string

- Defined in utilities/Cartographer.ts:86
Get the name of a room offset from the anchor room

Parameters
- roomName: string
- xDelta: number
- yDelta: number
Returns string

Static findRoomCoordDeltas

findRoomCoordDeltas(origin: string, otherRoom: string): object

- Defined in utilities/Cartographer.ts:111
Parameters
- origin: string
- otherRoom: string
Returns object

Static findRoomsAtRange

findRoomsAtRange(roomName: string, depth: number): string[]

- Defined in utilities/Cartographer.ts:25
Lists all rooms up at a given distance away, including roomName

Parameters
- roomName: string
- depth: number
Returns string[]

Static findRoomsInRange

findRoomsInRange(roomName: string, depth: number): string[]

- Defined in utilities/Cartographer.ts:18
Lists all rooms up to a given distance away, including roomName

Parameters
- roomName: string
- depth: number
Returns string[]

Static getRoomCoordinates

getRoomCoordinates(roomName: string): RoomCoord

- Defined in utilities/Cartographer.ts:188
Parameters
- roomName: string
Returns RoomCoord

Static oppositeDir

oppositeDir(dir: string): string

- Defined in utilities/Cartographer.ts:173
Parameters
- dir: string
Returns string

Static recursiveRoomSearch

recursiveRoomSearch(roomName: string, maxDepth: number): object

- Defined in utilities/Cartographer.ts:32
Recursively enumerate all rooms from a root node using depth first search to a maximum depth

Parameters
- roomName: string
- maxDepth: number
Returns object
- [depth: number]: string[]

Static roomType

roomType(roomName: string): "SK" | "CORE" | "CTRL" | "ALLEY"

- Defined in utilities/Cartographer.ts:70
Get the type of the room

Parameters
- roomName: string
Returns "SK" | "CORE" | "CTRL" | "ALLEY"

Generated using TypeDoc