Class ScoreBoardChannel

Hierarchy

TimeboxEvoRequest
- ScoreBoardChannel

Index

Constructors

constructor

Properties

_PACKAGE_PREFIX

Accessors

Methods

Object literals

_opts

Constructors

constructor

new ScoreBoardChannel(opts?: ScoreBoardOptions): ScoreBoardChannel

- Defined in channels/scoreboard.ts:17
Generates the appropriate message to display the scoreboard

Parameters
- Optional opts: ScoreBoardOptions
  
  The options for the channel
Returns ScoreBoardChannel

Properties

Private _PACKAGE_PREFIX

_PACKAGE_PREFIX: string = "450600"

Accessors

blue

get blue(): number
set blue(int: number): void

- Defined in channels/scoreboard.ts:63
Gets the blue player score

Returns number
- Defined in channels/scoreboard.ts:56
Sets the blue player score

Parameters
- int: number
Returns void

messages

get messages(): TimeboxEvoMessageArray

Inherited from TimeboxEvoRequest.messages
- Defined in requests.ts:30
Returns the message queue

Returns TimeboxEvoMessageArray

The message queue

red

get red(): number
set red(int: number): void

- Defined in channels/scoreboard.ts:49
Gets the red player score

Returns number
- Defined in channels/scoreboard.ts:42
Sets the red player score

Parameters
- int: number
Returns void

Methods

Private _updateMessage

_updateMessage(): void

- Defined in channels/scoreboard.ts:30
Updates the message queue based on the parameters used

Returns void

clear

clear(): void

Inherited from TimeboxEvoRequest.clear
- Defined in requests.ts:22
Clears the message queue

Returns void

push

push(msg: string): number

Inherited from TimeboxEvoRequest.push
- Defined in requests.ts:15
This queues a message in the message queue

Parameters
- msg: string
  
  the message to append in the message queue
Returns number

the length of the message queue

Object literals

Private _opts

_opts: object

blue

blue: number = 0

red

red: number = 0

Generated using TypeDoc