Class Room

autostart

chats

creator

gameStart

id

match

name

name_safe

options

owner

players

public

replay

state

type

userLimit

isHost

• get isHost(): boolean

• Whether or not the client is the host

  Returns boolean

abort

• abort(): Promise<void>

• Abort the game

  Returns Promise<void>

chat

• chat(message, pinned?): Promise<{
      content: string;
      content_safe: string;
      pinned: boolean;
      system: boolean;
      user: {
          _id: string;
          role: Role;
          supporter: boolean;
          supporter_tier: number;
          username: string;
          verified: boolean;
      };
  }>

• Send a public message to the room's chat. The pinned parameter is the same as using the /announce command in TETR.IO The pinned parameter being true will result in an error if the client is not host.

  Parameters

  • message: string
  • pinned: boolean = false

  Returns Promise<{
      content: string;
      content_safe: string;
      pinned: boolean;
      system: boolean;
      user: {
          _id: string;
          role: Role;
          supporter: boolean;
          supporter_tier: number;
          username: string;
          verified: boolean;
      };
  }>

  Example

  await client.room!.chat('hi!');
  Copy

  Example

  await client.room!.chat('Important info:', true);
  Copy

clearChat

• clearChat(): Promise<void>

• Clears the chat

  Returns Promise<void>

kick

• kick(id, duration?): Promise<string>

• Kick a user from the room for a specified duration (if host)

  Parameters

  • id: string

    id of user to kick
  • duration: number = 900

    duration to kick the user, in seconds

  Returns Promise<string>

  Example

  await client.room!.kick('646f633d276f42a80ba44304', 100);
  Copy

leave

• leave(): Promise<void>

• Leave the current room

  Returns Promise<void>

  Example

  await client.room!.leave();
  Copy

move

• move(uid, bracket): Promise<undefined | {
      bracket: Bracket;
      uid: string;
  }>

• Move someone's bracket

  Parameters

  • uid: string
  • bracket: "player" | "spectator"

  Returns Promise<undefined | {
      bracket: Bracket;
      uid: string;
  }>

  Example

  await client.room!.move('646f633d276f42a80ba44304', 'spectator');
  Copy

setID

• setID(id): Promise<{
      auto: Autostart;
      creator: string;
      id: string;
      info: {};
      match: Match;
      name: string;
      name_safe: string;
      options: Options;
      owner: string;
      players: Player[];
      public: boolean;
      state: State;
      topic: {};
      type: "custom";
  }>

• Sets the room id (only works for supporter accounts)

  Parameters

  • id: string

  Returns Promise<{
      auto: Autostart;
      creator: string;
      id: string;
      info: {};
      match: Match;
      name: string;
      name_safe: string;
      options: Options;
      owner: string;
      players: Player[];
      public: boolean;
      state: State;
      topic: {};
      type: "custom";
  }>

  Example

  client.room!.setID('TEST');
  Copy

start

• start(): Promise<Ready>

• Start the game

  Returns Promise<Ready>

switch

• switch(bracket): Promise<undefined | {
      bracket: Bracket;
      uid: string;
  }>

• Switch bracket

  Parameters

  • bracket: "player" | "spectator"

  Returns Promise<undefined | {
      bracket: Bracket;
      uid: string;
  }>

  Example

  await client.room!.switch('player');
  Copy

takeHost

• takeHost(): Promise<string>

• Take host if you created the room

  Returns Promise<string>

transferHost

• transferHost(player): Promise<string>

• Give the host to someone else

  Parameters

  • player: string

  Returns Promise<string>

  Example

  await client.room!.transferHost(await client.social.resolve('halp'));
  Copy

unban

• unban(username): void

• Unban a user from the room

  Parameters

  • username: string

  Returns void

  Example

  client.room!.unban('halp');
  Copy

update

• update<T>(...options): Promise<{
      auto: Autostart;
      creator: string;
      id: string;
      info: {};
      match: Match;
      name: string;
      name_safe: string;
      options: Options;
      owner: string;
      players: Player[];
      public: boolean;
      state: State;
      topic: {};
      type: "custom";
  }>

• Update the room's config, similar to using the /set command in tetr.io await client.room!.update({ index: 'name', value: 'test room'});

  Type Parameters

  • T extends
        | "name"
        | "options.presets"
        | "userLimit"
        | "autoStart"
        | "allowAnonymous"
        | "allowUnranked"
        | "userRankLimit"
        | "useBestRankAsLimit"
        | "forceRequireXPToChat"
        | "gamebgm"
        | "match.gamemode"
        | "match.modename"
        | "match.ft"
        | "match.wb"
        | "options.g"
        | "options.passthrough"
        | "options.allclears"
        | "options.stock"
        | "options.display_next"
        | "options.display_hold"
        | "options.gmargin"
        | "options.gincrease"
        | "options.garbagemultiplier"
        | "options.garbagemargin"
        | "options.garbageincrease"
        | "options.garbagecap"
        | "options.garbagecapincrease"
        | "options.garbagecapmax"
        | "options.garbageattackcap"
        | "options.garbageabsolutecap"
        | "options.garbagephase"
        | "options.garbagequeue"
        | "options.garbageare"
        | "options.garbageentry"
        | "options.garbageblocking"
        | "options.garbagetargetbonus"
        | "options.bagtype"
        | "options.spinbonuses"
        | "options.combotable"
        | "options.kickset"
        | "options.nextcount"
        | "options.allow_harddrop"
        | "options.display_shadow"
        | "options.locktime"
        | "options.garbagespeed"
        | "options.are"
        | "options.lineclear_are"
        | "options.infinitemovement"
        | "options.lockresets"
        | "options.allow180"
        | "options.room_handling"
        | "options.room_handling_arr"
        | "options.room_handling_das"
        | "options.room_handling_sdf"
        | "options.manual_allowed"
        | "options.b2bchaining"
        | "options.b2bcharging"
        | "options.openerphase"
        | "options.allclear_garbage"
        | "options.allclear_b2b"
        | "options.garbagespecialbonus"
        | "options.roundmode"
        | "options.clutch"
        | "options.nolockout"
        | "options.boardwidth"
        | "options.boardheight"
        | "options.messiness_change"
        | "options.messiness_inner"
        | "options.messiness_nosame"
        | "options.messiness_timeout"
        | "options.usebombs"

  Parameters

  • Rest...options: {
        index: T;
        value: DeepKeyValue<SetConfig, T>;
    }[]

  Returns Promise<{
      auto: Autostart;
      creator: string;
      id: string;
      info: {};
      match: Match;
      name: string;
      name_safe: string;
      options: Options;
      owner: string;
      players: Player[];
      public: boolean;
      state: State;
      topic: {};
      type: "custom";
  }>

usePreset

• usePreset(preset): Promise<{
      auto: Autostart;
      creator: string;
      id: string;
      info: {};
      match: Match;
      name: string;
      name_safe: string;
      options: Options;
      owner: string;
      players: Player[];
      public: boolean;
      state: State;
      topic: {};
      type: "custom";
  }>

• Sets the room's preset

  Parameters

  • preset: Preset

  Returns Promise<{
      auto: Autostart;
      creator: string;
      id: string;
      info: {};
      match: Match;
      name: string;
      name_safe: string;
      options: Options;
      owner: string;
      players: Player[];
      public: boolean;
      state: State;
      topic: {};
      type: "custom";
  }>

  Example

  await client.room!.usePreset('tetra league (season 1)');
  Copy