Class Bot

me

• get me(): Player

  Returns Player

players

• get players(): (Player | undefined)[]

  Returns (Player | undefined)[]

constructor

• new Bot(params?: Partial<BotParams>): Bot

  Parameters

  • params: Partial<BotParams> = {}

  Returns Bot

$emit

• $emit<K extends keyof BotEvents>(event: K, ...args: BotEvents[K]): void

  Type Parameters

  • K extends keyof BotEvents

  Parameters

  • event: K
  • ...args: BotEvents[K]

  Returns void

createAccount

• createAccount(email: string, pass: string): Promise<LoginResponse>

  Parameters

  • email: string
  • pass: string

  Returns Promise<LoginResponse>

createMatchmaker

• createMatchmaker(): Promise<
      | { ok: true; regionList: Region[] }
      | { error: MatchmakerError; ok: false },
  >

  Returns Promise<
      | { ok: true; regionList: Region[] }
      | { error: MatchmakerError; ok: false },
  >

createPrivateGame

• createPrivateGame(
      region: string,
      mode: string | number,
      map: string,
  ): Promise<
      | FindGameResponse
      | { error: LoginError
      | MatchmakerError
      | GameFindError; ok: false },
  >

  Parameters

  • region: string
  • mode: string | number
  • map: string

  Returns Promise<
      | FindGameResponse
      | { error: LoginError
      | MatchmakerError
      | GameFindError; ok: false },
  >

dispatch

• dispatch(
      command:
          | BanPlayerCommand
          | BootPlayerCommand
          | ChatCommand
          | FireCommand
          | GameOptionsCommand
          | GoToAmmoCommand
          | GoToCoopCommand
          | GoToGrenadeCommand
          | GoToPlayerCommand
          | GoToSpatulaCommand
          | LookAtCommand
          | MeleeCommand
          | MovementCommand
          | PauseCommand
          | ReloadCommand
          | ReportPlayerCommand
          | ResetGameCommand
          | SaveLoadoutCommand
          | SpawnCommand
          | SwapWeaponCommand
          | SwitchTeamCommand
          | ThrowGrenadeCommand
          | LookAtPosCommand,
      _isEmit?: boolean,
  ): boolean

  Parameters

  • command:
        | BanPlayerCommand
        | BootPlayerCommand
        | ChatCommand
        | FireCommand
        | GameOptionsCommand
        | GoToAmmoCommand
        | GoToCoopCommand
        | GoToGrenadeCommand
        | GoToPlayerCommand
        | GoToSpatulaCommand
        | LookAtCommand
        | MeleeCommand
        | MovementCommand
        | PauseCommand
        | ReloadCommand
        | ReportPlayerCommand
        | ResetGameCommand
        | SaveLoadoutCommand
        | SpawnCommand
        | SwapWeaponCommand
        | SwitchTeamCommand
        | ThrowGrenadeCommand
        | LookAtPosCommand
  • Optional_isEmit: boolean

  Returns boolean

dispose

• dispose(): void

  Returns void

emit

• emit<
      E extends
          | "pause"
          | "chat"
          | "saveLoadout"
          | "banPlayer"
          | "bootPlayer"
          | "fire"
          | "gameOptions"
          | "goToAmmo"
          | "goToCoop"
          | "goToGrenade"
          | "goToPlayer"
          | "goToSpatula"
          | "lookAt"
          | "lookAtPos"
          | "melee"
          | "move"
          | "reload"
          | "reportPlayer"
          | "resetGame"
          | "spawn"
          | "swapWeapon"
          | "switchTeam"
          | "throwGrenade",
  >(
      event: E,
      ...args: CommandParams[E],
  ): void

  Type Parameters

  • E extends
        | "pause"
        | "chat"
        | "saveLoadout"
        | "banPlayer"
        | "bootPlayer"
        | "fire"
        | "gameOptions"
        | "goToAmmo"
        | "goToCoop"
        | "goToGrenade"
        | "goToPlayer"
        | "goToSpatula"
        | "lookAt"
        | "lookAtPos"
        | "melee"
        | "move"
        | "reload"
        | "reportPlayer"
        | "resetGame"
        | "spawn"
        | "swapWeapon"
        | "switchTeam"
        | "throwGrenade"

  Parameters

  • event: E
  • ...args: CommandParams[E]

  Returns void

errorLogger

• errorLogger(...args: any[]): void

  Parameters

  • ...args: any[]

  Returns void

findPublicGame

• findPublicGame(
      region: string,
      mode: string | number,
  ): Promise<
      | FindGameResponse
      | { error: LoginError
      | MatchmakerError
      | GameFindError; ok: false },
  >

  Parameters

  • region: string
  • mode: string | number

  Returns Promise<
      | FindGameResponse
      | { error: LoginError
      | MatchmakerError
      | GameFindError; ok: false },
  >

initSession

• initSession(): Promise<
      { ok: true }
      | { error: LoginError | MatchmakerError; ok: false },
  >

  Returns Promise<{ ok: true } | { error: LoginError | MatchmakerError; ok: false }>

join

• join(
      name: string,
      data: string | FindGameResponse,
      defaultWeapon?: number,
  ): Promise<
      | { ok: true }
      | { error: LoginError | MatchmakerError | GameJoinError; ok: false },
  >

  Parameters

  • name: string
  • data: string | FindGameResponse
  • OptionaldefaultWeapon: number

  Returns Promise<
      | { ok: true }
      | { error: LoginError | MatchmakerError | GameJoinError; ok: false },
  >

login

• login(email: string, pass: string): Promise<LoginResponse>

  Parameters

  • email: string
  • pass: string

  Returns Promise<LoginResponse>

loginAnonymously

• loginAnonymously(): Promise<LoginResponse>

  Returns Promise<LoginResponse>

loginWithRefreshToken

• loginWithRefreshToken(refreshToken: string): Promise<LoginResponse>

  Parameters

  • refreshToken: string

  Returns Promise<LoginResponse>

off

• off<K extends keyof BotEvents>(
      event: K,
      cb?: (...args: BotEvents[K]) => void,
  ): void

  Type Parameters

  • K extends keyof BotEvents

  Parameters

  • event: K
  • Optionalcb: (...args: BotEvents[K]) => void

  Returns void

on

• on<K extends keyof BotEvents>(
      event: K,
      cb: (...args: BotEvents[K]) => void,
  ): void

  Type Parameters

  • K extends keyof BotEvents

  Parameters

  • event: K
  • cb: (...args: BotEvents[K]) => void

  Returns void

onAny

• onAny(cb: (...args: any[]) => void): void

  Parameters

  • cb: (...args: any[]) => void

  Returns void

processLoginData

• processLoginData(
      loginData:
          | {
              banRemaining?: string;
              firebase: RawFirebase;
              ok: true;
              playerOutput: RawLoginData;
          }
          | { error: APIError; ok: false },
      email?: string,
      pass?: string,
  ): LoginResponse

  Parameters

  • loginData:
        | {
            banRemaining?: string;
            firebase: RawFirebase;
            ok: true;
            playerOutput: RawLoginData;
        }
        | { error: APIError; ok: false }
  • Optionalemail: string
  • Optionalpass: string

  Returns LoginResponse

$commands

Optionalaccount

api

connectionTimeout

Optionalgame

instance

intents

matchmaker

matchmakerListeners

packetHandlers

protocol

proxy

regionList

useAltGameURL