Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Bottle

A bottle thrown by a bartender at a Tile.

Hierarchy

Implements

  • IBaseGameObject

Index

Properties

Methods

Properties

direction

direction: "North" | "East" | "South" | "West"

The Direction this Bottle is flying and will move to between turns, can be 'North', 'East', 'South', or 'West'.

drunkDirection

drunkDirection: "North" | "East" | "South" | "West"

The direction any Cowboys hit by this will move, can be 'North', 'East', 'South', or 'West'.

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.

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

True if this Bottle has impacted and has been destroyed (removed from the Game). False if still in the game flying through the saloon.

logs

logs: string[]

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

tile

tile: Tile | undefined

The Tile this bottle is currently flying over.

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