Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GUI

Terminal GUI manager using ncurses All GUI references and interactions are handled through this so the server is independent from it.

Hierarchy

  • GUI

Index

Constructors

Properties

Methods

Constructors

constructor

  • new GUI(title: string, host: string, port: number): GUI

  • Start a GUI for the server

    Parameters

    • title: string

      Window title

    • host: string

      Server host

    • port: number

      Server port

    Returns GUI

Properties

gameArea

gameArea: blessed.Widgets.BoxElement

Game list UI reference

games

games: Array<GameUI>

List of games currently being played

logger

logger: blessed.Widgets.Log

Log box UI reference

onlineUsers

onlineUsers: blessed.Widgets.BoxElement

Online users box UI reference

screen

screen: blessed.Widgets.Screen

Main screen UI reference

Methods

addGameBox

  • addGameBox(playerOne: string, playerTwo: string): number

  • Add a new game UI

    Parameters

    • playerOne: string

      Token of player 1

    • playerTwo: string

      Token of player 2

    Returns number

    Game Box ID

log

  • log(message: string, skipRender?: boolean): void

  • Log a message to the log box

    Parameters

    • message: string

      Message

    • Default value skipRender: boolean = false

      Avoid rendering, useful if multiple messages will be logged

    Returns void

render

  • render(): void

renderOnlinePlayers

  • renderOnlinePlayers(players: Array<string>): void

  • Render the given list of player tokens

    Parameters

    • players: Array<string>

      Player list

    Returns void

setGameEnd

  • setGameEnd(gameIndex: number, winner: string, state: State): void

  • Change a game UI to finished mode

    Parameters

    • gameIndex: number

      Game Box ID

    • winner: string

      Winner token

    • state: State

      Game state

    Returns void

setGameProgress

  • setGameProgress(gameIndex: number, progress: number): void

  • Update the game progress between two players

    Parameters

    • gameIndex: number

      Game Box ID

    • progress: number

      Progress from 0 o 100

    Returns void

Generated using TypeDoc