Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Job

Information about a unit's job.

Hierarchy

Implements

  • IBaseGameObject

Index

Properties

Methods

Properties

carryLimit

carryLimit: number

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

damage

damage: number

The amount of damage this Job does per attack.

energy

energy: number

The amount of starting health this Job has.

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.

moves

moves: number

The distance this job can move per turn.

range

range: number

The distance at which this job can effect things.

shield

shield: number

The reserve the martyr use to protect allies.

title

title: "corvette" | "missileboat" | "martyr" | "transport" | "miner"

The Job title. 'corvette', 'missileboat', 'martyr', 'transport', or 'miner'. (in this order from 0-4).

unitCost

unitCost: number

How much money it costs to spawn a unit.

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