Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Spawner

A resource spawner that generates branches or food.

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.

hasBeenHarvested

hasBeenHarvested: boolean

True if this Spawner has been harvested this turn, and it will not heal at the end of the turn, false otherwise.

health

health: number

How much health this Spawner has, which is used to calculate how much of its resource can be harvested.

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.

tile

tile: Tile

The Tile this Spawner is on.

type

type: "food" | "branches"

What type of resource this is ('food' or 'branches').

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