Tile
Direct Subclass:
A grid tile in the dungeon
Constructor Summary
Public Constructor | ||
public |
constructor(x: number, y: number) |
Method Summary
Public Methods | ||
public |
Adds an Item to the pile of Items on the Tile. |
|
public |
Gets the Creature on this Tile |
|
public |
getDirectDistance(other: Tile): number Gets the Chebyshev distance between this Tile and another. |
|
public |
getEuclideanDistance(other: Tile): number Gets the Euclidean distance between this Tile and another, using the Pythagorean Theorem. |
|
public |
Gets the list of Items on this Tile |
|
public |
Gets a human-friendly name for this Tile |
|
public |
getNeighbors4(dungeon: Dungeon): Array<Tile> Gets the (up to) 4 neighbors in the cardinal directions from this Tile |
|
public |
getNeighbors8(dungeon: Dungeon): Array<Tile> Gets all Tiles immediately adjacent to this Tile (including diagonally) |
|
public |
getRoomKey(): string Gets the room key for this Tile, if any |
|
public |
Get's the x coordinate of this tile |
|
public |
Get's the y coordinate of this tile |
|
public |
Tells whether this tile is considered a floor (not a pit). |
|
public |
Tells whether this tile is opaque (e.g. |
|
public |
Tells whether this tile is solid (e.g. |
|
public |
Removes the Creature from this Tile, if any |
|
public |
removeItem(param: Item | number): * Removes an Item from the Tile |
|
public |
setCreature(creature: Creature) Sets the Creature occupying this Tile. |
|
public |
setRoomKey(key: string) Sets an identifier telling which room the Tile belongs to. |
|
public |
Gets a debug representation of this Tile |
Public Constructors
Public Methods
public addItem(item: Item) source
Adds an Item to the pile of Items on the Tile. There is no limit to the number of items on a Tile
Params:
Name | Type | Attribute | Description |
item | Item | The Item to add |
public getDirectDistance(other: Tile): number source
Gets the Chebyshev distance between this Tile and another. This is the number of steps a walking Creature will need to take to travel between the two tiles, assuming no obstacles
Params:
Name | Type | Attribute | Description |
other | Tile | The to which distance will be measured |
public getEuclideanDistance(other: Tile): number source
Gets the Euclidean distance between this Tile and another, using the Pythagorean Theorem. This is used when determining if something is within range of a ranged attack
Params:
Name | Type | Attribute | Description |
other | Tile | The to which distance will be measured |
public getNeighbors4(dungeon: Dungeon): Array<Tile> source
Gets the (up to) 4 neighbors in the cardinal directions from this Tile
Params:
Name | Type | Attribute | Description |
dungeon | Dungeon | The dungeon this tile is in |
public getNeighbors8(dungeon: Dungeon): Array<Tile> source
Gets all Tiles immediately adjacent to this Tile (including diagonally)
Params:
Name | Type | Attribute | Description |
dungeon | Dungeon | The dungeon this tile is in |
public hasFloor(): boolean source
Tells whether this tile is considered a floor (not a pit). Most Creatures cannot walk over non-floor Tiles
public isOpaque(): boolean source
Tells whether this tile is opaque (e.g. a wall). Most Creatures cannot see through opaque Tiles.
public isSolid(): boolean source
Tells whether this tile is solid (e.g. a wall). Most Creatures cannot pass through solid Tiles.
public setCreature(creature: Creature) source
Sets the Creature occupying this Tile. A Tile can have a maximum of one Creature
Params:
Name | Type | Attribute | Description |
creature | Creature | The Creature to place on this Tile |