Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Tile

A Tile in the game that makes up the 2D map grid.

Hierarchy

Implements

  • IBaseGameObject

Index

Properties

bottle

bottle: Bottle | undefined

The beer Bottle currently flying over this Tile, null otherwise.

cowboy

cowboy: Cowboy | undefined

The Cowboy that is on this Tile, null otherwise.

furnishing

furnishing: Furnishing | undefined

The furnishing that is on this Tile, null otherwise.

gameObjectName

gameObjectName: string

String representing the top level Class that this game object is an instance of. Used for reflection to create new instances on clients, but exposed for convenience should AIs want this data.

hasHazard

hasHazard: boolean

If this Tile is pathable, but has a hazard that damages Cowboys that path through it.

id

id: string

A unique id for each instance of a GameObject or a sub class. Used for client and server communication. Should never change value after being set.

isBalcony

isBalcony: boolean

If this Tile is a balcony of the Saloon that YoungGuns walk around on, and can never be pathed through by Cowboys.

logs

logs: string[]

Any strings logged will be stored here. Intended for debugging.

tileEast

tileEast: Tile | undefined

The Tile to the 'East' of this one (x+1, y). Null if out of bounds of the map.

tileNorth

tileNorth: Tile | undefined

The Tile to the 'North' of this one (x, y-1). Null if out of bounds of the map.

tileSouth

tileSouth: Tile | undefined

The Tile to the 'South' of this one (x, y+1). Null if out of bounds of the map.

tileWest

tileWest: Tile | undefined

The Tile to the 'West' of this one (x-1, y). Null if out of bounds of the map.

x

x: number

The x (horizontal) position of this Tile.

y

y: number

The y (vertical) position of this Tile.

youngGun

youngGun: YoungGun | undefined

The YoungGun on this tile, null otherwise.

Static directions

directions: ["North", "East", "South", "West"] = ["North", "East", "South", "West"]

Gets the valid directions that tiles can be in, "North", "East", "South", or "West"

returns

Methods

getNeighbors

  • getNeighbors(): Tile[]
  • Gets the neighbors of this Tile.

    Returns Tile[]

    The neighboring (adjacent) Tiles to this tile.

hasNeighbor

  • hasNeighbor(tile: Tile | undefined): boolean
  • Checks if this Tile has a specific neighboring Tile

    Parameters

    • tile: Tile | undefined

    Returns boolean

    true if the tile is a neighbor of this Tile, false otherwise

isPathable

  • isPathable(): boolean
  • Checks if a Tile is pathable to units

    Returns boolean

    True if pathable, false otherwise

log

  • log(message: string): Promise<void>
  • Adds a message to this GameObject's logs. Intended for your own debugging purposes, as strings stored here are saved in the gamelog.

    Parameters

    • message: string

      A string to add to this GameObject's log. Intended for debugging.

    Returns Promise<void>

toString

  • toString(): string
  • A toString override for easier debugging.

    example

    String(gameObject); 🠞 "GameObjectName #1245"

    Returns string

    A human readable representation of the game object.

Generated using TypeDoc