Class Player

constructor

• new Player(controller?: null | PlayerProps | OHD, $b?: PlayerProps): Player

  Parameters

  • controller: null | PlayerProps | OHD = null
  • $b: PlayerProps = ...

  Returns Player

_events

created

id

name

steam64

isBot

• get isBot(): boolean

  Is the player a Bot

  Returns boolean

addAdmin

• addAdmin(): Promise<CommandSuccess>

  Give the user Admin Access

  Returns Promise<CommandSuccess>

ban

• ban(
      duration?: number,
      reason?: string,
  ): Promise<{ reason: string; success: false }> | Promise<PlayerBanned>

  Ban the current Player

  Parameters

  • duration: number = 0
  • Optionalreason: string

  Returns Promise<{ reason: string; success: false }> | Promise<PlayerBanned>

kick

• kick(
      reason?: string,
  ): Promise<{ reason: string; success: false }> | Promise<PlayerKicked>

  Kick the current Player

  Parameters

  • reason: string = 'You have been Kicked!'

  Returns Promise<{ reason: string; success: false }> | Promise<PlayerKicked>

on

• on(event: "PLAYER_LEFT", cb: () => void): EventEmitter

  The player has Left the Server

  Parameters

  • event: "PLAYER_LEFT"
  • cb: () => void

  Returns EventEmitter
• on(event: "PLAYER_DELETED", cb: () => void): EventEmitter

  The player has been cleared out of memory

  Parameters

  • event: "PLAYER_DELETED"
  • cb: () => void

  Returns EventEmitter
• on(event: "PLAYER_KICKED", cb: (event: PlayerKicked) => void): EventEmitter

  The player has been Kicked

  Parameters

  • event: "PLAYER_KICKED"
  • cb: (event: PlayerKicked) => void

  Returns EventEmitter
• on(event: "PLAYER_BANNED", cb: (event: PlayerBanned) => void): EventEmitter

  The player has been Banned

  Parameters

  • event: "PLAYER_BANNED"
  • cb: (event: PlayerBanned) => void

  Returns EventEmitter

removeAdmin

• removeAdmin(): Promise<CommandSuccess>

  Revoke the users Admin Access

  Returns Promise<CommandSuccess>

removeListener

• removeListener(
      event: string | symbol,
      cb: (...args: any[]) => void,
  ): EventEmitter

  Parameters

  • event: string | symbol
  • cb: (...args: any[]) => void

  Returns EventEmitter

setTeam

• setTeam(teamId: 0 | 1 | Teams): Promise<unknown>

  Set the team of the current Player

  Parameters

  • teamId: 0 | 1 | Teams

  Returns Promise<unknown>