Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Machine

A machine in the game. Used to refine ore.

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.

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.

logs

logs: string[]

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

oreType

oreType: "redium" | "blueium"

What type of ore the machine takes it. Also determines the type of material it outputs. (redium or blueium).

refineInput

refineInput: number

The amount of ore that needs to be inputted into the machine for it to be worked.

refineOutput

refineOutput: number

The amount of refined ore that is returned after the machine has been fully worked.

refineTime

refineTime: number

The number of times this machine needs to be worked to refine ore.

tile

tile: Tile

The Tile this Machine is on.

worked

worked: number

Tracks how many times this machine has been worked. (0 to refineTime).

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