Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Tile

A Tile in the game that makes up the 2D map grid.

Hierarchy

Implements

  • IBaseGameObject

Index

Properties

Methods

Properties

blueium

blueium: number

The amount of blueium on this tile.

blueiumOre

blueiumOre: number

The amount of blueium ore on this tile.

decoration

decoration: number

(Visualizer only) Different tile types, cracked, slightly dirty, etc. This has no effect on gameplay, but feel free to use it if you want.

direction

direction: "blank" | "north" | "east" | "south" | "west"

The direction of a conveyor belt ('blank', 'north', 'east', 'south', or 'west'). Blank means conveyor doesn't move.

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.

isWall

isWall: boolean

Whether or not the tile is a wall.

logs

logs: string[]

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

machine

machine: Machine | undefined

The Machine on this Tile if present, otherwise null.

owner

owner: Player | undefined

The owner of this Tile, or null if owned by no-one. Only for generators and spawn areas.

redium

redium: number

The amount of redium on this tile.

rediumOre

rediumOre: number

The amount of redium ore on this tile.

tileEast

tileEast: Tile | undefined

The Tile to the 'East' of this one (x+1, y). Null if out of bounds of the map.

tileNorth

tileNorth: Tile | undefined

The Tile to the 'North' of this one (x, y-1). Null if out of bounds of the map.

tileSouth

tileSouth: Tile | undefined

The Tile to the 'South' of this one (x, y+1). Null if out of bounds of the map.

tileWest

tileWest: Tile | undefined

The Tile to the 'West' of this one (x-1, y). Null if out of bounds of the map.

type

type: "normal" | "generator" | "conveyor" | "spawn"

The type of Tile this is ('normal', 'generator', 'conveyor', or 'spawn').

unit

unit: Unit | undefined

The Unit on this Tile if present, otherwise null.

x

x: number

The x (horizontal) position of this Tile.

y

y: number

The y (vertical) position of this Tile.

Static directions

directions: ["North", "East", "South", "West"] = ["North", "East", "South", "West"]

Gets the valid directions that tiles can be in, "North", "East", "South", or "West"

returns

Methods

getNeighbors

  • getNeighbors(): Tile[]

  • Gets the neighbors of this Tile.

    Returns Tile[]

    The neighboring (adjacent) Tiles to this tile.

hasNeighbor

  • hasNeighbor(tile: Tile | undefined): boolean

  • Checks if this Tile has a specific neighboring Tile

    Parameters

    • tile: Tile | undefined

    Returns boolean

    true if the tile is a neighbor of this Tile, false otherwise

isPathable

  • isPathable(): boolean

  • Checks if a Tile is pathable to units

    Returns boolean

    True if pathable, 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>

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