Class OHD

constructor

• new OHD(ip: string, port: number, password: string, options?: OHDOptions): OHD

  Parameters

  • ip: string
  • port: number
  • password: string
  • Optionaloptions: OHDOptions

  Returns OHD

_events

debug

logParser

onReady

players

rconParser

recentPlayerLimit

recentPlayers

reconnect

serverStatus

variables

• get variables(): ServerVariables

  Dot Access Setter for Server Variables.

  Do not ever set an accessor to a variable, always use .read() and .write()

  Returns ServerVariables

variablesUnsafe

• get variablesUnsafe(): UnsafeVariables

  Dot Access Setter for Server Variables.

  Do not ever set an accessor to a variable, always use .read() and .write()

  Returns UnsafeVariables

addAdmin

• addAdmin(name: string | number): Promise<CommandSuccess>

  Give the user Admin Access

  Parameters

  • name: string | number

  Returns Promise<CommandSuccess>

addAdminById

• addAdminById(id: number): Promise<CommandSuccess>

  Give the user Admin Access

  Parameters

  • id: number

  Returns Promise<CommandSuccess>

addBluforBots

• addBluforBots(amount: number): Promise<unknown>

  Add bots to the Blufor Team

  Parameters

  • amount: number

  Returns Promise<unknown>

addBots

• addBots(amount?: number): Promise<void>

  Add amount bots to the server.

  Parameters

  • amount: number = 1

  Returns Promise<void>

addNamedBot

• addNamedBot(name?: string): Promise<void>

  Add a Named Bot to the server.

  Parameters

  • name: string = 'Chuck Norris'

  Returns Promise<void>

addOpforBots

• addOpforBots(amount: number): Promise<unknown>

  Add bots to the Opfor Team

  Parameters

  • amount: number

  Returns Promise<unknown>

addTeamBots

• addTeamBots(team: 0 | 1 | Teams, amount: number): Promise<unknown>

  Add bots to a specified Team

  Parameters

  • team: 0 | 1 | Teams
  • amount: number

  Returns Promise<unknown>

ban

• ban(
      name: string | number,
      duration?: number,
      reason?: string,
  ): Promise<PlayerBanned>

  Ban a Player from the server by Username.

  Parameters

  • name: string | number
  • duration: number = 0

    Duration in Seconds
  • Optionalreason: string

  Returns Promise<PlayerBanned>

banId

• banId(id: number, duration?: number, reason?: string): Promise<PlayerBanned>

  Ban a Player from the server by PlayerID.

  Parameters

  • id: number
  • duration: number = 0

    Duration in Seconds
  • Optionalreason: string

  Returns Promise<PlayerBanned>

createMapQuery

• createMapQuery(options?: MapQueryProps): MapQuery

  Create a new MapQuery Object to use with serverTravel().

  Parameters

  • Optionaloptions: MapQueryProps

  Returns MapQuery

disconnect

• disconnect(): void

  Disconnect the client.

  Returns void

forceTeam

• forceTeam(name: string, teamId: 0 | 1 | Teams): Promise<unknown>

  Force the team of a Player by Username.

  1: Blufor

  0: Opfor

  Parameters

  • name: string
  • teamId: 0 | 1 | Teams

  Returns Promise<unknown>

forceTeamId

• forceTeamId(id: number, teamId: 0 | 1 | Teams): Promise<unknown>

  Force the team of a Player by PlayerID.

  1: Blufor

  0: Opfor

  Parameters

  • id: number
  • teamId: 0 | 1 | Teams

  Returns Promise<unknown>

kick

• kick(name: string | number, reason?: string): Promise<PlayerKicked>

  Kick a Player from the server by Username

  Parameters

  • name: string | number
  • reason: string = 'You have been Kicked'

  Returns Promise<PlayerKicked>

kickId

• kickId(id: number, reason?: string): Promise<PlayerKicked>

  Kick a Player from the server by PlayerID

  Parameters

  • id: number
  • reason: string = 'You have been Kicked'

  Returns Promise<PlayerKicked>

on

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

  The bot is ready

  Parameters

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

  Returns EventEmitter
• on(event: "CHAT", cb: (message: Message) => void): EventEmitter

  Chat messages sent in the server

  Parameters

  • event: "CHAT"
  • cb: (message: Message) => void

  Returns EventEmitter
• on(event: "PLAYER_JOINED", cb: (player: Player) => void): EventEmitter

  The player joined the server

  Parameters

  • event: "PLAYER_JOINED"
  • cb: (player: Player) => void

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

  The player left the server

  Parameters

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

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

  The player was deleted from memory

  Parameters

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

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

  The player was kicked

  Parameters

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

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

  The player was banned

  Parameters

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

  Returns EventEmitter

removeAdmin

• removeAdmin(name: string | number): Promise<CommandSuccess>

  Revoke the users Admin Access

  Parameters

  • name: string | number

  Returns Promise<CommandSuccess>

removeAdminById

• removeAdminById(id: number): Promise<CommandSuccess>

  Revoke the users Admin Access

  Parameters

  • id: number

  Returns Promise<CommandSuccess>

removeAllBots

• removeAllBots(): Promise<void>

  Remove all bots from the server.

  Returns Promise<void>

removeBluforBots

• removeBluforBots(amount: number): Promise<unknown>

  Remove bots from the Blufor Team

  Parameters

  • amount: number

  Returns Promise<unknown>

removeListener

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

  Parameters

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

  Returns EventEmitter

removeOpforBots

• removeOpforBots(amount: number): Promise<unknown>

  Remove bots from the Opfor Team

  Parameters

  • amount: number

  Returns Promise<unknown>

removeTeamBots

• removeTeamBots(team: 0 | 1 | Teams, amount: number): Promise<unknown>

  Remove bots from the specified Team

  Parameters

  • team: 0 | 1 | Teams
  • amount: number

  Returns Promise<unknown>

say

• say(message: string): Promise<unknown>

  Send a message to all players.

  Parameters

  • message: string

  Returns Promise<unknown>

  Note

  These messages only display from the in-game console currently.

send

• send<T>(cmd: string): Promise<T>

  Send a Raw RCON command.

  Type Parameters

  • T

  Parameters

  • cmd: string

  Returns Promise<T>

serverTravel

• serverTravel(map: string | MapQuery): Promise<unknown>

  Change the current Level.

  Parameters

  • map: string | MapQuery

  Returns Promise<unknown>

status

• status(): Promise<ServerStatus>

  Get the Server Status.

  Returns Promise<ServerStatus>