Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Checker

A checker on the game board.

Hierarchy

Implements

  • IBaseGameObject

Index

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.

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.

kinged

kinged: boolean

If the checker has been kinged and can move backwards.

logs

logs: string[]

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

owner

owner: Player

The player that controls this Checker.

x

x: number

The x coordinate of the checker.

y

y: number

The y coordinate of the checker.

Methods

isMine

  • isMine(): Promise<boolean>
  • Returns if the checker is owned by your player or not.

    Returns Promise<boolean>

    True if it is yours, false if it is not yours.

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>

move

  • move(x: number, y: number): Promise<Checker | undefined>
  • Moves the checker from its current location to the given (x, y).

    Parameters

    • x: number

      The x coordinate to move to.

    • y: number

      The y coordinate to move to.

    Returns Promise<Checker | undefined>

    Returns the same checker that moved if the move was successful. Otherwise null.

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