Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Job

Information about a beaver's job.

Hierarchy

Implements

  • IBaseGameObject

Index

Properties

Methods

Properties

actions

actions: number

The number of actions this Job can make per turn.

carryLimit

carryLimit: number

How many combined resources a beaver with this Job can hold at once.

chopping

chopping: number

Scalar for how many branches this Job harvests at once.

cost

cost: number

How much food this Job costs to recruit.

damage

damage: number

The amount of damage this Job does per attack.

distractionPower

distractionPower: number

How many turns a beaver attacked by this Job is distracted by.

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

The amount of starting health this Job 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.

logs

logs: string[]

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

moves

moves: number

The number of moves this Job can make per turn.

munching

munching: number

Scalar for how much food this Job harvests at once.

title

title: string

The Job title.

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>

recruit

  • recruit(tile: Tile): Promise<Beaver | undefined>

  • Recruits a Beaver of this Job to a lodge.

    Parameters

    • tile: Tile

      The Tile that is a lodge owned by you that you wish to spawn the Beaver of this Job on.

    Returns Promise<Beaver | undefined>

    The recruited Beaver if successful, null otherwise.

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