Options
All
  • Public
  • Public/Protected
  • All
Menu

Class User

Hierarchy

  • User

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new User(user: User): User
  • new User(id: string, session: string): User

Properties

Private _admin

_admin: boolean = false

Private _cache

_cache: Array<object> = []

Private _canVote

_canVote: boolean = false

Private _cannotRegister

_cannotRegister: boolean = false

Private _color

_color: Colors = Colors.none

Private _deadCache

_deadCache: Array<string> = []

Private _disconnected

_disconnected: boolean = false

Private _game

_game: undefined | Game = undefined

Private _gameClickedLast

_gameClickedLast: string = ""

Private _id

_id: string

Private _inGame

_inGame: boolean = false

Private _leftMessageCache

_leftMessageCache: Array<Message> = []

Private _registered

_registered: boolean = false

Private _selectedUserName

_selectedUserName: string = ""

Private _session

_session: string = ""

Private _sockets

_sockets: Array<Socket> = []

Private _startVote

_startVote: boolean = false

Private _stopwatch

_stopwatch: Stopwatch

Private _time

_time: number = 0

Private _username

_username: string = "randomuser"

Private _warn

_warn: number = 0

Accessors

admin

  • get admin(): boolean

cache

  • get cache(): object[]

cannotRegister

  • get cannotRegister(): boolean

color

deadCache

  • get deadCache(): Array<string>

disconnected

  • get disconnected(): boolean

game

  • get game(): undefined | Game
  • set game(game: undefined | Game): void

gameClickedLast

  • get gameClickedLast(): string
  • set gameClickedLast(game: string): void

id

  • get id(): string

ifCanVote

  • get ifCanVote(): boolean

inGame

  • get inGame(): boolean
  • set inGame(isInGame: boolean): void

leftCache

registered

  • get registered(): boolean

selectedUsername

  • get selectedUsername(): string

session

  • get session(): string

socketCount

  • get socketCount(): number

startVote

  • get startVote(): boolean
  • set startVote(startVote: boolean): void

title

  • set title(title: string): void

  • Sets html title of client.

    Parameters

    • title: string

    Returns void

username

  • get username(): string

Methods

addListingToGame

  • addListingToGame(username: string, color: string, game: Game): void

  • Parameters

    • username: string
    • color: string
    • game: Game

    Returns void

addNewGameToLobby

  • addNewGameToLobby(name: string, type: string, uid: string): void

  • Parameters

    • name: string
    • type: string
    • uid: string

    Returns void

addPlayerToLobbyList

  • addPlayerToLobbyList(username: string): void

  • Parameters

    • username: string

    Returns void

addSocket

  • addSocket(socket: Socket): void

  • Parameters

    • socket: Socket

    Returns void

banFromRegistering

  • banFromRegistering(): void

canVote

  • canVote(): void

cancelVoteEffect

  • cancelVoteEffect(): void

cannotVote

  • cannotVote(): void

disconnect

  • disconnect(): void

emit

  • emit(event: string, ...args: Array<string | number | string[] | boolean | undefined | Array<object> | Message>): void

  • Sends event to this user

    memberof

    User

    Parameters

    • event: string
    • Rest ...args: Array<string | number | string[] | boolean | undefined | Array<object> | Message>

    Returns void

equals

  • equals(otherUser: User): boolean

getTime

  • getTime(): number

getWarn

  • getWarn(): number

hang

  • hang(usernames: Array<string>): void

  • Parameters

    • usernames: Array<string>

    Returns void

headerSend

  • headerSend(message: Message): void

leftSend

  • leftSend(message: string, textColor?: Colors, backgroundColor?: Colors): void

  • Parameters

    • message: string
    • Optional textColor: Colors
    • Optional backgroundColor: Colors

    Returns void

lineThroughUser

  • lineThroughUser(msg: string, color: string): void

  • Parameters

    • msg: string
    • color: string

    Returns void

lobbyMessage

  • lobbyMessage(msg: string, textColor: Colors, backgroundColor?: Colors): void

markAsDead

  • markAsDead(msg: string): void

  • Parameters

    • msg: string

    Returns void

markGameStatusInLobby

  • markGameStatusInLobby(game: Game, status: string): void

register

  • register(): void

registrationError

  • registrationError(message: string): void

  • Parameters

    • message: string

    Returns void

reloadClient

  • reloadClient(): void

removeGameFromLobby

  • removeGameFromLobby(uid: string): void

  • Parameters

    • uid: string

    Returns void

removeLeft

  • removeLeft(msg: string): void

  • Parameters

    • msg: string

    Returns void

removePlayerFromLobbyList

  • removePlayerFromLobbyList(username: string): void

  • Parameters

    • username: string

    Returns void

removePlayerListingFromGame

  • removePlayerListingFromGame(username: string, game: Game): void

  • Removes another user's username from the lobby E.g the other user has left.

    Parameters

    • username: string
    • game: Game

    Returns void

removeRight

  • removeRight(msg: string): void

  • Parameters

    • msg: string

    Returns void

removeSocket

  • removeSocket(socket: Socket): void

  • Parameters

    • socket: Socket

    Returns void

resetAfterGame

  • resetAfterGame(): void

resetGallows

  • resetGallows(): void

rightSend

selectUser

  • selectUser(username: string): void

  • Parameters

    • username: string

    Returns void

send

  • send message to this user and only this user

    Parameters

    Returns void

setTime

  • setTime(time: number, warn: number): void

  • Parameters

    • time: number
    • warn: number

    Returns void

setUsername

  • setUsername(username: string): void

  • Parameters

    • username: string

    Returns void

sound

  • sound(sound: string): void

  • Causes the client to emit a notification sound

    Parameters

    • sound: string

    Returns void

updateGameListing

  • updateGameListing(name: string, userNameColorPairs: Array<NameColorPair>, uid: string, inPlay: boolean): void

  • Parameters

    • name: string
    • userNameColorPairs: Array<NameColorPair>
    • uid: string
    • inPlay: boolean

    Returns void

verifyAsAdmin

  • verifyAsAdmin(msg: string): boolean

  • Parameters

    • msg: string

    Returns boolean

Generated using TypeDoc