Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BroodMother

The Spider Queen. She alone can spawn Spiderlings for each Player, and if she dies the owner loses.

Hierarchy

Implements

  • IBaseGameObject

Index

Properties

eggs

eggs: number

How many eggs the BroodMother has to spawn Spiderlings this turn.

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

How much health this BroodMother has left. When it reaches 0, she dies and her owner loses.

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.

nest

nest: Nest | undefined

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

owner

owner: Player

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

Methods

consume

  • consume(spiderling: Spiderling): Promise<boolean>
  • Consumes a Spiderling of the same owner to regain some eggs to spawn more Spiderlings.

    Parameters

    • spiderling: Spiderling

      The Spiderling to consume. It must be on the same Nest as this BroodMother.

    Returns Promise<boolean>

    True if the Spiderling was consumed. 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>

spawn

  • spawn(spiderlingType: "Spitter" | "Weaver" | "Cutter"): Promise<Spiderling | undefined>
  • Spawns a new Spiderling on the same Nest as this BroodMother, consuming an egg.

    Parameters

    • spiderlingType: "Spitter" | "Weaver" | "Cutter"

      The string name of the Spiderling class you want to Spawn. Must be 'Spitter', 'Weaver', or 'Cutter'.

    Returns Promise<Spiderling | undefined>

    The newly spawned Spiderling 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