Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Furnishing

An furnishing in the Saloon that must be pathed around, or destroyed.

Hierarchy

Implements

  • IBaseGameObject

Index

Properties

Methods

Properties

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.

health

health: number

How much health this Furnishing currently has.

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.

isDestroyed

isDestroyed: boolean

If this Furnishing has been destroyed, and has been removed from the game.

isPiano

isPiano: boolean

True if this Furnishing is a piano and can be played, False otherwise.

isPlaying

isPlaying: boolean

If this is a piano and a Cowboy is playing it this turn.

logs

logs: string[]

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

tile

tile: Tile | undefined

The Tile that this Furnishing is located on.

Methods

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