Class Room

Properties

allowAnonymous

allowAnonymous: boolean

Whether or not the room allows anonymous users

allowBots

allowBots: boolean

Whether or not the room allows bots

allowChat

allowChat: boolean

Whether or not chatting is allowed

allowQueued

allowQueued: boolean

Whether or not the room allows users queued for TL

allowUnranked

allowUnranked: boolean

Whether or not the room allows unranked users

auto

auto: Autostart

The autostart state of the room

autoStart

autoStart: number

The autostart config of the room

bgmList

bgmList: unknown[]

The list of available BGMs

chats

chats: {
    content: string;
    content_safe?: string;
    pinned?: boolean;
    suppressable?: boolean;
    system: boolean;
    user: {
        _id: string | null;
        role?: Role;
        supporter?: boolean;
        supporter_tier?: number;
        username: string;
    };
}[] = []

Room chat history

constants

constants: unknown

The room constants

creator

creator: string

UID of the room creator (this person can reclaim host)

forceRequireXPToChat

forceRequireXPToChat: boolean

Whether or not to force require XP to chat

gamebgm

gamebgm: string

The background music of the game

gameStart

gameStart: number | null = null

The time the last game started

id

id: string

the ID of the room

lobbybg

lobbybg: string | null

The background image of the lobby

lobbybgm

lobbybgm: string

The background music of the lobby

match

match: Match

The match config for the room

name

name: string

Name of the room

name_safe

name_safe: string

Safe Name of the room

options

options: Partial<Options>

The room config. Note that TETR.IO does not send all options when joining a room, and some properties may not be present (hence the Partial)

owner

owner: string

UID of the host

players

players: Types.Room.Player[]

The players in the room

public

public: boolean

Whether or not the room is public

replay

replay: ReplayManager | null = null

The replay data for the last played game

state

state: Types.Room.State

The current state of the room (ingame | lobby)

type

type: Type

The type of the room

useBestRankAsLimit

useBestRankAsLimit: boolean

Whether or not to use best rank as limit

userLimit

userLimit: number

The maxiumum number of players that can play in the room (override by moving as host)

userRankLimit

userRankLimit: Rank

The user rank limit to play in the room

Accessors

isHost

get isHost(): boolean
Whether or not the client is the host

Returns boolean
- Defined in src/classes/room/index.ts:277

self

get self(): Types.Room.Player | null
Returns Types.Room.Player | null
- Defined in src/classes/room/index.ts:281

Methods

abort

abort(): Promise<null | undefined>
Abort the game

Returns Promise<null | undefined>
- Defined in src/classes/room/index.ts:422

ban

ban(id: string): Promise<string>
Ban a user from the room (if host) Uses room.kick under the hood, the same way TETR.IO does
Parameters
- id: string
  id of user to ban
Returns Promise<string>
Example
```
await client.room!.ban('646f633d276f42a80ba44304');
```
- Defined in src/classes/room/index.ts:330

chat

chat(
    message: string,
    pinned?: boolean,
): Promise<
    {
        content: string;
        content_safe?: string;
        pinned?: boolean;
        suppressable?: boolean;
        system: boolean;
        user: {
            _id: string
            | null;
            role?: Role;
            supporter?: boolean;
            supporter_tier?: number;
            username: string;
        };
    },
>
Send a 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;
        suppressable?: boolean;
        system: boolean;
        user: {
            _id: string
            | null;
            role?: Role;
            supporter?: boolean;
            supporter_tier?: number;
            username: string;
        };
    },
>
Example
```
await client.room!.chat('hi!');
```
Example
```
await client.room!.chat('Important info:', true);
```
- Defined in src/classes/room/index.ts:352

clearChat

clearChat(): Promise<void>
Clears the chat

Returns Promise<void>
- Defined in src/classes/room/index.ts:363

destroy

destroy(): void
For internal use only. Use room.leave() instead.

Returns void
- Defined in src/classes/room/index.ts:288

kick

kick(id: string, duration?: number): 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);
```
- Defined in src/classes/room/index.ts:315

leave

leave(): Promise<void>
Leave the current room

Returns Promise<void>
Example
```
await client.room!.leave();
```
- Defined in src/classes/room/index.ts:303

move

move(
uid: string,
bracket: "player" | "spectator",
): Promise<{ bracket: Bracket; uid: string } | undefined>
Move someone's bracket
Parameters
- uid: string
- bracket: "player" | "spectator"
Returns Promise<{ bracket: Bracket; uid: string } | undefined>
Example
```
await client.room!.move('646f633d276f42a80ba44304', 'spectator');
```
- Defined in src/classes/room/index.ts:521

setID

setID(
    id: string,
): Promise<
    {
        allowAnonymous: boolean;
        allowBots: boolean;
        allowChat?: boolean;
        allowQueued: boolean;
        allowUnranked: boolean;
        auto: Autostart;
        autoStart: number;
        bgmList: unknown[];
        constants: unknown;
        creator: string;
        forceRequireXPToChat: boolean;
        gamebgm: string;
        id: string;
        info: Record<string, unknown>;
        lobbybg: string | null;
        lobbybgm: string;
        match: Match;
        name: string;
        name_safe?: string;
        options: Partial<Options>;
        owner: string;
        players: Types.Room.Player[];
        public: boolean;
        state: Types.Room.State;
        topic: Record<string, unknown>;
        type: Type;
        useBestRankAsLimit: boolean;
        userLimit: number;
        userRankLimit: Rank;
    },
>
Sets the room id (only works for supporter accounts)
Parameters
- id: string
Returns Promise<
    {
        allowAnonymous: boolean;
        allowBots: boolean;
        allowChat?: boolean;
        allowQueued: boolean;
        allowUnranked: boolean;
        auto: Autostart;
        autoStart: number;
        bgmList: unknown[];
        constants: unknown;
        creator: string;
        forceRequireXPToChat: boolean;
        gamebgm: string;
        id: string;
        info: Record<string, unknown>;
        lobbybg: string | null;
        lobbybgm: string;
        match: Match;
        name: string;
        name_safe?: string;
        options: Partial<Options>;
        owner: string;
        players: Types.Room.Player[];
        public: boolean;
        state: Types.Room.State;
        topic: Record<string, unknown>;
        type: Type;
        useBestRankAsLimit: boolean;
        userLimit: number;
        userRankLimit: Rank;
    },
>
Example
```
client.room!.setID('TEST');
```
- Defined in src/classes/room/index.ts:376

spectate

spectate(): Promise<void | SpectateData>
Start spectating a game.

Returns Promise<void | SpectateData>
The current state of the game being spectated.
Example
```
const data = await client.room!.spectate();
```
- Defined in src/classes/room/index.ts:433

start

start(): Promise<Ready>
Start the game

Returns Promise<Ready>
- Defined in src/classes/room/index.ts:415

switch

switch(
bracket: "player" | "spectator",
): Promise<{ bracket: Bracket; uid: string } | undefined>
Switch bracket
Parameters
- bracket: "player" | "spectator"
Returns Promise<{ bracket: Bracket; uid: string } | undefined>
Example
```
await client.room!.switch('player');
```
- Defined in src/classes/room/index.ts:501

takeHost

takeHost(): Promise<string>
Take host if you created the room

Returns Promise<string>
- Defined in src/classes/room/index.ts:488

transferHost

transferHost(player: string): Promise<string>
Give the host to someone else
Parameters
- player: string
Returns Promise<string>
Example
```
await client.room!.transferHost(await client.social.resolve('halp'));
```
- Defined in src/classes/room/index.ts:479

unban

unban(username: string): Client
Unban a user from the room
Parameters
- username: string
Returns Client
Example
```
client.room!.unban('halp');
```
- Defined in src/classes/room/index.ts:339

unspectate

unspectate(): Promise<void>
Stop spectating the current game.

Returns Promise<void>
Example
```
await client.room!.unspectate();
```
- Defined in src/classes/room/index.ts:466

update

update(
    ...options: SetConfigItem[],
): Promise<
    {
        allowAnonymous: boolean;
        allowBots: boolean;
        allowChat?: boolean;
        allowQueued: boolean;
        allowUnranked: boolean;
        auto: Autostart;
        autoStart: number;
        bgmList: unknown[];
        constants: unknown;
        creator: string;
        forceRequireXPToChat: boolean;
        gamebgm: string;
        id: string;
        info: Record<string, unknown>;
        lobbybg: string | null;
        lobbybgm: string;
        match: Match;
        name: string;
        name_safe?: string;
        options: Partial<Options>;
        owner: string;
        players: Types.Room.Player[];
        public: boolean;
        state: Types.Room.State;
        topic: Record<string, unknown>;
        type: Type;
        useBestRankAsLimit: boolean;
        userLimit: number;
        userRankLimit: Rank;
    },
>
Update the room's config, similar to using the /set command in tetr.io await client.room!.update({ index: 'name', value: 'test room'});
Parameters
- ...options: SetConfigItem[]
Returns Promise<
    {
        allowAnonymous: boolean;
        allowBots: boolean;
        allowChat?: boolean;
        allowQueued: boolean;
        allowUnranked: boolean;
        auto: Autostart;
        autoStart: number;
        bgmList: unknown[];
        constants: unknown;
        creator: string;
        forceRequireXPToChat: boolean;
        gamebgm: string;
        id: string;
        info: Record<string, unknown>;
        lobbybg: string | null;
        lobbybgm: string;
        match: Match;
        name: string;
        name_safe?: string;
        options: Partial<Options>;
        owner: string;
        players: Types.Room.Player[];
        public: boolean;
        state: Types.Room.State;
        topic: Record<string, unknown>;
        type: Type;
        useBestRankAsLimit: boolean;
        userLimit: number;
        userRankLimit: Rank;
    },
>
- Defined in src/classes/room/index.ts:389

usePreset

usePreset(
    preset: Preset,
): Promise<
    {
        allowAnonymous: boolean;
        allowBots: boolean;
        allowChat?: boolean;
        allowQueued: boolean;
        allowUnranked: boolean;
        auto: Autostart;
        autoStart: number;
        bgmList: unknown[];
        constants: unknown;
        creator: string;
        forceRequireXPToChat: boolean;
        gamebgm: string;
        id: string;
        info: Record<string, unknown>;
        lobbybg: string | null;
        lobbybgm: string;
        match: Match;
        name: string;
        name_safe?: string;
        options: Partial<Options>;
        owner: string;
        players: Types.Room.Player[];
        public: boolean;
        state: Types.Room.State;
        topic: Record<string, unknown>;
        type: Type;
        useBestRankAsLimit: boolean;
        userLimit: number;
        userRankLimit: Rank;
    },
>
Sets the room's preset
Parameters
- preset: Preset
Returns Promise<
    {
        allowAnonymous: boolean;
        allowBots: boolean;
        allowChat?: boolean;
        allowQueued: boolean;
        allowUnranked: boolean;
        auto: Autostart;
        autoStart: number;
        bgmList: unknown[];
        constants: unknown;
        creator: string;
        forceRequireXPToChat: boolean;
        gamebgm: string;
        id: string;
        info: Record<string, unknown>;
        lobbybg: string | null;
        lobbybgm: string;
        match: Match;
        name: string;
        name_safe?: string;
        options: Partial<Options>;
        owner: string;
        players: Types.Room.Player[];
        public: boolean;
        state: Types.Room.State;
        topic: Record<string, unknown>;
        type: Type;
        useBestRankAsLimit: boolean;
        userLimit: number;
        userRankLimit: Rank;
    },
>
Example
```
await client.room!.usePreset('tetra league (season 1)');
```
- Defined in src/classes/room/index.ts:408

Class Room

Index

Properties

Accessors

Methods

Properties

allowAnonymous

allowBots

allowChat

allowQueued

allowUnranked

auto

autoStart

bgmList

chats

constants

creator

forceRequireXPToChat

gamebgm

gameStart

id

lobbybg

lobbybgm

match

name

name_safe

options

owner

players

public

replay

state

type

useBestRankAsLimit

userLimit

userRankLimit

Accessors

isHost

Returns boolean

self

Returns Types.Room.Player | null

Methods

abort

Returns Promise<null | undefined>

ban

Parameters

Returns Promise<string>

Example

chat

Parameters

Returns Promise< { content: string; content_safe?: string; pinned?: boolean; suppressable?: boolean; system: boolean; user: { _id: string | null; role?: Role; supporter?: boolean; supporter_tier?: number; username: string; }; },>

Example

Example

clearChat

Returns Promise<void>

destroy

Returns void

kick

Parameters

Returns Promise<string>

Example

leave

Returns Promise<void>

Example

move

Parameters

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

Example

setID

Parameters

Example

spectate

Returns Promise<void | SpectateData>

Example

start

Returns Promise<Ready>

switch

Parameters

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

Example

Returns Promise<
{
content: string;
content_safe?: string;
pinned?: boolean;
suppressable?: boolean;
system: boolean;
user: {
_id: string
| null;
role?: Role;
supporter?: boolean;
supporter_tier?: number;
username: string;
};
},
>