Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Spitter

A Spiderling that creates and spits new Webs from the Nest it is on to another Nest, connecting them.

Hierarchy

Implements

  • IBaseGameObject

Index

Properties

Methods

Properties

busy

busy: "" | "Moving" | "Attacking" | "Strengthening" | "Weakening" | "Cutting" | "Spitting"

When empty string this Spiderling is not busy, and can act. Otherwise a string representing what it is busy with, e.g. 'Moving', 'Attacking'.

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.

isDead

isDead: boolean

If this Spider is dead and has been removed from the game.

logs

logs: string[]

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

movingOnWeb

movingOnWeb: Web | undefined

The Web this Spiderling is using to move. Null if it is not moving.

movingToNest

movingToNest: Nest | undefined

The Nest this Spiderling is moving to. Null if it is not moving.

nest

nest: Nest | undefined

The Nest that this Spider is currently on. Null when moving on a Web.

numberOfCoworkers

numberOfCoworkers: number

The number of Spiderlings busy with the same work this Spiderling is doing, speeding up the task.

owner

owner: Player

The Player that owns this Spider, and can command it.

spittingWebToNest

spittingWebToNest: Nest | undefined

The Nest that this Spitter is creating a Web to spit at, thus connecting them. Null if not spitting.

workRemaining

workRemaining: number

How much work needs to be done for this Spiderling to finish being busy. See docs for the Work formula.

Methods

attack

  • attack(spiderling: Spiderling): Promise<boolean>

  • Attacks another Spiderling.

    Parameters

    • spiderling: Spiderling

      The Spiderling to attack.

    Returns Promise<boolean>

    True if the attack was successful, false otherwise.

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(web: Web): Promise<boolean>

  • Starts moving the Spiderling across a Web to another Nest.

    Parameters

    • web: Web

      The Web you want to move across to the other Nest.

    Returns Promise<boolean>

    True if the move was successful, false otherwise.

spit

  • spit(nest: Nest): Promise<boolean>

  • Creates and spits a new Web from the Nest the Spitter is on to another Nest, connecting them.

    Parameters

    • nest: Nest

      The Nest you want to spit a Web to, thus connecting that Nest and the one the Spitter is on.

    Returns Promise<boolean>

    True if the spit was successful, false 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