Class: Room

Represents a room.

Hierarchy

• Base

  ↳ Room

Properties

client

• client: Client

Inherited from

Base.client

---

isPublic

• isPublic: boolean

Whether or not the room is a public.

---

isTribeHouse

• isTribeHouse: boolean

Whether or not the room is a tribe house.

---

language

• language: Language

The room language.

---

name

• name: string

The room name.

---

playerList

• playerList: RoomPlayer[]

All of the Player that are in the room.

Methods

addPlayer

▸ addPlayer(player): void

Add player to player list

Parameters

Name	Type
player	RoomPlayer

Returns

void

---

getPlayer

▸ getPlayer(name): undefined | RoomPlayer

Get a player by the pcode or name.

Parameters

Name	Type
name	string

Returns

undefined | RoomPlayer

Example

const player = client.room.getPlayer('Name#0000');
console.log(player.look);

▸ getPlayer(pcode): undefined | RoomPlayer

Parameters

Name	Type
pcode	number

Returns

undefined | RoomPlayer

---

sendMessage

▸ sendMessage(message): void

Sends a message to the room.

Parameters

Name	Type
message	string

Returns

void