Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Client

Class representing the local Roblox client.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly handler

handler: RequestHandler

user

user: ClientUser

Methods

addListener

emit

  • emit<E>(event: E, ...args: Arguments<ClientEvents[E]>): boolean

  • Type parameters

    Parameters

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getBadge

  • getBadge(id: number): Promise<Badge>

getMaxListeners

  • getMaxListeners(): number

joinGame

  • joinGame(id: number): Promise<void>

  • Joins game with a game id.

    remarks

    This method only works on Windows operating system.

    experimental

    Parameters

    • id: number

      the game id

    Returns Promise<void>

listenerCount

  • listenerCount<E>(event: E): number

listeners

  • listeners<E>(event: E): Function[]

  • Type parameters

    Parameters

    • event: E

    Returns Function[]

login

  • login(cookie: string): Promise<string>

  • Logins the client to Roblox.

    see

    the documentation to get your cookie

    Parameters

    • cookie: string

      a .ROBLOSECURITY cookie

    Returns Promise<string>

    the cookie parameter if this was successful

off

on

once

prependListener

prependOnceListener

rawListeners

  • rawListeners<E>(event: E): Function[]

removeAllListeners

  • removeAllListeners<E>(event?: E): Client

removeListener

setMaxListeners

  • setMaxListeners(maxListeners: number): Client

Generated using TypeDoc