Class STLiveGame

Structure representing a live game, or a game which was in progress at the time it was fetched.

Hierarchy

  • STLiveGame

Constructors

constructor

Properties

map mode players teams timeLeft timeLeftString type

Constructors

constructor

  • new STLiveGame(obj: { gameMode: string; gameType: string; mapName: string; players: any; teams: { name: string; score: number }[]; timeLeft: number; timeLeftString: string }): STLiveGame

  • Parameters

    • obj: { gameMode: string; gameType: string; mapName: string; players: any; teams: { name: string; score: number }[]; timeLeft: number; timeLeftString: string }

      The object to take properties from, as supplied by the API

      • gameMode: string
      • gameType: string
      • mapName: string
      • players: any
      • teams: { name: string; score: number }[]
      • timeLeft: number
      • timeLeftString: string

    Returns STLiveGame

Properties

map

map: string

The name of the map.

mode

mode: string

The game mode.

players

players: STGamePlayer[]

An array of the players, including spectators.

teams

teams: STTeam[]

An array of the teams playing.

timeLeft

timeLeft: number

How many total seconds are left in the game.

timeLeftString

timeLeftString: string

How much time is left in the game, expressed as a String. Ex: 4:20.

type

type: string

The type of game. See type.

Settings

Member Visibility

Theme

Generated using TypeDoc