Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Nest

A location (node) connected to other Nests via Webs (edges) in the game that Spiders can converge on, regardless of owner.

Hierarchy

Implements

  • IBaseGameObject

Index

Properties

Methods

Properties

controllingPlayer

controllingPlayer: Player | undefined

The Player that 'controls' this Nest as they have the most Spiders on this nest.

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.

spiders

spiders: Spider[]

All the Spiders currently located on this Nest.

webs

webs: Web[]

Webs that connect to this Nest.

x

x: number

The X coordinate of the Nest. Used for distance calculations.

y

y: number

The Y coordinate of the Nest. Used for distance calculations.

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